com.anrisoftware.globalpom.initfileparser.external.InitFileParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of globalpomutils-initfileparser Show documentation

Parses INI like files.

There is a newer version: 4.7.0

Show newest version

/*
 * Copyright 2016 Erwin Müller 
 *
 * 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 com.anrisoftware.globalpom.initfileparser.external;

import java.util.Iterator;
import java.util.concurrent.Callable;

/**
 * Parses INI files.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface InitFileParser extends Callable,
        Iterable {

    /**
     * Loads the INI file to parsing it.
     * 
     * @return this {@link InitFileParser}
     * 
     * @throws InitFileParserException
     *             when an error opening or reading the INI file was encounted.
     */
    @Override
    InitFileParser call() throws InitFileParserException;

    /**
     * Parses and returns the sections of the INI file.
     * 
     * @return the {@link Iterator} that returns the {@link Section} sections.
     */
    @Override
    Iterator iterator();
}