ninja.leaping.configurate.loader.CommentHandler Maven / Gradle / Ivy

Go to download
/**
 * Configurate
 * Copyright (C) zml and Configurate contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ninja.leaping.configurate.loader;

import com.google.common.base.Optional;

import java.io.BufferedReader;
import java.io.IOException;
import java.util.Collection;

/**
 * Interface specifying methods for handling abstract comments
 */
public interface CommentHandler {
    Optional extractHeader(BufferedReader reader) throws IOException;
    /**
     * Convert the given lines into a comment
     * @param lines The lines to make a comment
     * @return The transformed lines
     */
    Collection toComment(Collection lines);
}