001// *************************************************************************************************************************** 002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file * 003// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file * 004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance * 005// * with the License. You may obtain a copy of the License at * 006// * * 007// * http://www.apache.org/licenses/LICENSE-2.0 * 008// * * 009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an * 010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * 011// * specific language governing permissions and limitations under the License. * 012// *************************************************************************************************************************** 013package org.apache.juneau.config.encode; 014 015import org.apache.juneau.config.*; 016 017/** 018 * API for defining a string encoding/decoding mechanism for entries in {@link Config}. 019 * 020 * <ul class='seealso'> 021 * <li class='link'>{@doc juneau-config.EncodedEntries} 022 * </ul> 023 */ 024public interface ConfigEncoder { 025 026 /** 027 * Encode a string. 028 * 029 * @param fieldName The field name being encoded. 030 * @param in The unencoded input string. 031 * @return The encoded output string. 032 */ 033 public String encode(String fieldName, String in); 034 035 /** 036 * Decode a string. 037 * 038 * @param fieldName The field name being decoded. 039 * @param in The encoded input string. 040 * @return The decoded output string. 041 */ 042 public String decode(String fieldName, String in); 043 044 /** 045 * Returns <jk>true</jk> if the specified string is encoded. 046 * 047 * @param in The input string. 048 * @return 049 * <jk>true</jk> if the specified string is encoded. 050 * <br>Returns <jk>false</jk> if the string is <jk>null</jk>. 051 */ 052 public boolean isEncoded(String in); 053}