Top Description Fields Constructors Methods
org.stringtemplate.v4.compiler

public Class FormalArgument

extends Object
Class Inheritance
Imports
org.antlr.runtime.Token
Represents the name of a formal argument defined in a template: 
 test(a,b,x=defaultvalue) ::= "<a> <n> <x>"
Each template has a set of these formal arguments or sets CompiledST#hasFormalArgs to false (indicating that no arguments were specified such as when we create a template with new ST(...)).

Note

originally, I tracked cardinality as well as the name of an attribute. I'm leaving the code here as I suspect something may come of it later. Currently, though, cardinality is not used.

Field Summary

Modifier and TypeField and Description
public CompiledST
compiledDefaultValue

public Object
defaultValue

public Token
defaultValueToken

If they specified default value x=y, store the token here

public int
index

public String
name

Constructor Summary

AccessConstructor and Description
public
FormalArgument(String name)

public
FormalArgument(String name, Token defaultValueToken)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

compiledDefaultValueback to summary
public CompiledST compiledDefaultValue
defaultValueback to summary
public Object defaultValue
defaultValueTokenback to summary
public Token defaultValueToken

If they specified default value x=y, store the token here

indexback to summary
public int index
nameback to summary
public String name

Constructor Detail

FormalArgumentback to summary
public FormalArgument(String name)
FormalArgumentback to summary
public FormalArgument(String name, Token defaultValueToken)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override