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 * <h5 class='section'>See Also:</h5>
021 * <ul class='doctree'>
022 *    <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-config.EncodedEntries'>Overview &gt; juneau-config &gt; Encoded Entries</a>
023 * </ul>
024 */
025public interface ConfigEncoder {
026
027   /**
028    * Encode a string.
029    * 
030    * @param fieldName The field name being encoded.
031    * @param in The unencoded input string.
032    * @return The encoded output string.
033    */
034   public String encode(String fieldName, String in);
035
036   /**
037    * Decode a string.
038    * 
039    * @param fieldName The field name being decoded.
040    * @param in The encoded input string.
041    * @return The decoded output string.
042    */
043   public String decode(String fieldName, String in);
044   
045   /**
046    * Returns <jk>true</jk> if the specified string is encoded.
047    * 
048    * @param in The input string.
049    * @return 
050    *    <jk>true</jk> if the specified string is encoded.
051    *    <br>Returns <jk>false</jk> if the string is <jk>null</jk>.
052    */
053   public boolean isEncoded(String in);
054}