1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.geometry.io.euclidean.threed;
18
19 /** Interface for reading {@link FacetDefinition facet definitions} from an input source.
20 * @see FacetDefinition
21 */
22 public interface FacetDefinitionReader extends AutoCloseable {
23
24 /** Return the next facet definition from the input source or null if no more
25 * facets are available.
26 * @return the next facet definition or null if no more facets
27 * are available
28 * @throws IllegalStateException if a data format error occurs
29 * @throws java.io.UncheckedIOException if an I/O error occurs
30 */
31 FacetDefinition readFacet();
32
33 /** Close this instance and release all associated resources.
34 * @throws java.io.UncheckedIOException if an I/O error occurs
35 */
36 @Override
37 void close();
38 }