01: /*
02: * <copyright>
03: *
04: * Copyright 2000-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.tools.csmart.util.parser;
28:
29: import java.io.IOException;
30:
31: /**
32: * Parser <br><br>
33: *
34: * An interface to define a Properties file parser.
35: */
36: public interface Parser {
37:
38: /**
39: * parse <br><br>
40: *
41: * Actual parse method that parses the file.
42: * <br>
43: * @throws IOException
44: */
45: void parse() throws IOException;
46:
47: /**
48: * setCommentChar <br><br>
49: *
50: * Sets the character that represents a comment
51: * in the file.
52: * <br>
53: * @param chr Comment start character.
54: */
55: void setCommentChar(String chr);
56:
57: /**
58: * setSeparatorChar <br><br>
59: *
60: * Sets the character that is used to separate fields
61: * in the file.
62: * <br>
63: * @param chr Separator character.
64: */
65: void setSeparatorChar(String chr);
66:
67: /**
68: * load <br><br>
69: *
70: * Loads in a file to be parsed.
71: * <br>
72: * @param filename The name of the file to load
73: * @throws IOException
74: */
75: void load(String filename) throws IOException;
76: }
|