View Javadoc

1   //Copyright 2007-2008, by the California Institute of Technology.
2   //ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.
3   //Any commercial use must be negotiated with the Office of Technology Transfer
4   //at the California Institute of Technology.
5   //
6   //This software is subject to U. S. export control laws and regulations
7   //(22 C.F.R. 120-130 and 15 C.F.R. 730-774). To the extent that the software
8   //is subject to U.S. export control laws and regulations, the recipient has
9   //the responsibility to obtain export licenses or other export authority as
10  //may be required before exporting such information to foreign countries or
11  //providing access to foreign nationals.
12  
13  package gov.nasa.pds.ltdt.label.statement;
14  
15  /***
16   * Interface for creating statement objects that can be used to provide
17   * string representations of Statements in a PDS label.
18   * 
19   * @author mcayanan
20   *
21   */
22  public interface PrettyStatement {
23  	
24  	/***
25  	 * Return a string representation of a statement where there is no
26  	 * indentation and the '=' is placed 2 spaces after the identifier.
27  	 */
28  	public String toString();
29  	
30  	/***
31  	 * Return a string representation of a statement where the indentation
32  	 * is specified. The '=' is placed 2 spaces after the identifier.
33  	 * 
34  	 * @param indentLength The number of spaces to indent the statement.
35  	 */
36  	public String toString(short indentLength);
37  	
38  	/***
39  	 * Return a string representation of a statement where the indentation
40  	 * and the position of the '=' are defined.
41  	 * 
42  	 * @param indentLength The number of spaces to indent the statement.
43  	 * @param equalsPosition The position of the '='.
44  	 */
45  	public String toString(short indentLength, int equalsPosition);
46  }