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.commons.geometry.io.euclidean.threed;
018
019/** Interface for reading {@link FacetDefinition facet definitions} from an input source.
020 * @see FacetDefinition
021 */
022public interface FacetDefinitionReader extends AutoCloseable {
023
024    /** Return the next facet definition from the input source or null if no more
025     * facets are available.
026     * @return the next facet definition or null if no more facets
027     *      are available
028     * @throws IllegalStateException if a data format error occurs
029     * @throws java.io.UncheckedIOException if an I/O error occurs
030     */
031    FacetDefinition readFacet();
032
033    /** Close this instance and release all associated resources.
034     * @throws java.io.UncheckedIOException if an I/O error occurs
035     */
036    @Override
037    void close();
038}