001/* 002 * Configurate 003 * Copyright (C) zml and Configurate contributors 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * 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 ninja.leaping.configurate.loader; 018 019import org.checkerframework.checker.nullness.qual.NonNull; 020 021import java.io.BufferedReader; 022import java.io.IOException; 023import java.util.Collection; 024import java.util.Optional; 025 026/** 027 * Interface specifying methods for handling abstract comments 028 */ 029public interface CommentHandler { 030 031 /** 032 * Defines the handlers behaviour for reading comments. 033 * 034 * @param reader The reader 035 * @return The comment 036 * @throws IOException If any IO error occurs in the process 037 */ 038 @NonNull 039 Optional<String> extractHeader(@NonNull BufferedReader reader) throws IOException; 040 041 /** 042 * Converts the given lines into a comment 043 * 044 * @param lines The lines to make a comment 045 * @return The transformed lines 046 */ 047 @NonNull 048 Collection<String> toComment(@NonNull Collection<String> lines); 049 050}