1   /* Copyright 2002-2012 Space Applications Services
2    * Licensed to CS Systèmes d'Information (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS 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.orekit.files.general;
18  
19  import java.io.InputStream;
20  
21  import org.orekit.errors.OrekitException;
22  
23  /** Interface for orbit file parsers.
24   * @author Thomas Neidhart
25   */
26  public interface OrbitFileParser {
27  
28      /** Reads an orbit file from the given stream and returns a parsed
29       * {@link OrbitFile}.
30       * @param stream the stream to read from
31       * @return a parsed instance of {@link OrbitFile}
32       * @exception OrekitException if the orbit file could not be parsed
33       * successfully from the given stream
34       */
35      OrbitFile parse(final InputStream stream) throws OrekitException;
36  
37      /** Reads the orbit file and returns a parsed {@link OrbitFile}.
38       * @param fileName the file to read and parse
39       * @return a parsed instance of {@link OrbitFile}
40       * @exception OrekitException if the orbit file could not be parsed
41       * successfully from the given file
42       */
43      OrbitFile parse(final String fileName) throws OrekitException;
44  }