001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.config.format;
018
019import java.io.*;
020
021import org.apache.juneau.config.internal.*;
022
023/**
024 * Format strategy for config map persistence.
025 */
026public interface ConfigFormat {
027
028   /**
029    * Format identifier.
030    *
031    * @return Format identifier.
032    */
033   String id();
034
035   /**
036    * Normalizes source format text into INI-style content consumed by {@link ConfigMap}.
037    *
038    * @param contents The source contents.
039    * @return INI-style contents.
040    * @throws IOException Thrown by underlying stream.
041    */
042   String toInternal(String contents) throws IOException;
043
044   /**
045    * Writes a map to this format.
046    *
047    * @param map The map to write.
048    * @return Serialized contents in this format.
049    * @throws IOException Thrown by underlying stream.
050    */
051   String fromInternal(ConfigMap map) throws IOException;
052}