Top Description Inners Constructors Methods
org.jparsec

public final Class Tokens

extends Object
Class Inheritance

Provides common token values.
Author
Ben Yu

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Tokens.Fragment

Represents a fragment tagged according to its semantics.

public static class
Tokens.ScientificNotation

Represents a scientific notation with a significand (mantissa) and an exponent.

public static enum
Tokens.Tag

Pre-built Fragment token tags.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Tokens.Fragment

Returns:

the token value.
decimalLiteral
(String
the decimal string representation.
s
)

Returns a Fragment tagged as Tag#DECIMAL.

public static Tokens.Fragment
fragment(String
the fragment text.
text
,
Object
the tag representing the fragment's semantics.
tag
)

Returns a Fragment tagged with tag.

public static Tokens.Fragment

Returns:

the token value.
identifier
(String
the identifier.
name
)

Returns a Fragment tagged as Tag#IDENTIFIER.

public static Tokens.Fragment

Returns:

the token value.
integerLiteral
(String
the integer string representation.
s
)

Returns a Fragment tagged as Tag#INTEGER.

public static Tokens.Fragment

Returns:

the token value.
reserved
(String
the reserved word.
name
)

Returns a Fragment tagged as Tag#RESERVED.

public static Tokens.ScientificNotation
scientificNotation(String significand, String exponent)

Returns a ScientificNotation with significand before the 'e' or 'E' and exponent after.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Tokensback to summary
private Tokens()

Method Detail

decimalLiteralback to summary
public static Tokens.Fragment decimalLiteral(String s)

Returns a Fragment tagged as Tag#DECIMAL.

Parameters
s:String

the decimal string representation.

Returns:Tokens.Fragment

the token value.

fragmentback to summary
public static Tokens.Fragment fragment(String text, Object tag)

Returns a Fragment tagged with tag.

Parameters
text:String

the fragment text.

tag:Object

the tag representing the fragment's semantics.

identifierback to summary
public static Tokens.Fragment identifier(String name)

Returns a Fragment tagged as Tag#IDENTIFIER.

Parameters
name:String

the identifier.

Returns:Tokens.Fragment

the token value.

integerLiteralback to summary
public static Tokens.Fragment integerLiteral(String s)

Returns a Fragment tagged as Tag#INTEGER.

Parameters
s:String

the integer string representation.

Returns:Tokens.Fragment

the token value.

reservedback to summary
public static Tokens.Fragment reserved(String name)

Returns a Fragment tagged as Tag#RESERVED.

Parameters
name:String

the reserved word.

Returns:Tokens.Fragment

the token value.

scientificNotationback to summary
public static Tokens.ScientificNotation scientificNotation(String significand, String exponent)

Returns a ScientificNotation with significand before the 'e' or 'E' and exponent after.

org.jparsec back to summary

public final Class Tokens.Fragment

extends Object
Class Inheritance

Represents a fragment tagged according to its semantics. It's a convenience class so that you don't have to create many classes each for a different token. Instead, you could just use new fragment(text, "token1") to uniquely identify a token by the "token1" tag.

Field Summary

Modifier and TypeField and Description
private final Object
private final String

Constructor Summary

AccessConstructor and Description
public
Fragment(String text, Object tag)
Deprecated Use Tokens.fragment() instead.

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
public boolean
equals(Object
the reference object with which to compare.
obj
)

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 Object
tag()

Returns the tag of the token value.

public String
text()

Returns the text of the token value.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

tagback to summary
private final Object tag
textback to summary
private final String text

Constructor Detail

Fragmentback to summary
public Fragment(String text, Object tag)

Deprecated

Use Tokens.fragment() instead.

Annotations
@Deprecated

Method Detail

equalFragmentback to summary
pack-priv boolean equalFragment(Tokens.Fragment that)
equalsback to summary
public boolean equals(Object obj)

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
obj: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
tagback to summary
public Object tag()

Returns the tag of the token value.

textback to summary
public String text()

Returns the text of the token value.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.jparsec back to summary

public final Class Tokens.ScientificNotation

extends Object
Class Inheritance

Represents a scientific notation with a significand (mantissa) and an exponent. Both are represented with a String to avoid number range issue.

Field Summary

Modifier and TypeField and Description
public final String
exponent

The exponent after the "E".

public final String
significand

The significand (mantissa) before the "E".

Constructor Summary

AccessConstructor and Description
public
ScientificNotation(String mantissa, String exp)
Deprecated Use Tokens.scientificNotation() instead.

Method Summary

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

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

exponentback to summary
public final String exponent

The exponent after the "E".

significandback to summary
public final String significand

The significand (mantissa) before the "E".

Constructor Detail

ScientificNotationback to summary
public ScientificNotation(String mantissa, String exp)

Deprecated

Use Tokens.scientificNotation() instead.

Annotations
@Deprecated

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
obj: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. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.jparsec back to summary

public final Enum Tokens.Tag

extends Enum<Tokens.Tag>
Class Inheritance

Pre-built Fragment token tags.

Field Summary

Modifier and TypeField and Description
public static final Tokens.Tag
DECIMAL

Decimal number literal

public static final Tokens.Tag
IDENTIFIER

Regular identifier

public static final Tokens.Tag
INTEGER

Integral number literal

public static final Tokens.Tag
RESERVED

Reserved word

Constructor Summary

AccessConstructor and Description
private
Tag()

Method Summary

Modifier and TypeMethod and Description
public static Tokens.Tag
public static Tokens.Tag[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DECIMALback to summary
public static final Tokens.Tag DECIMAL

Decimal number literal

IDENTIFIERback to summary
public static final Tokens.Tag IDENTIFIER

Regular identifier

INTEGERback to summary
public static final Tokens.Tag INTEGER

Integral number literal

RESERVEDback to summary
public static final Tokens.Tag RESERVED

Reserved word

Constructor Detail

Tagback to summary
private Tag()

Method Detail

valueOfback to summary
public static Tokens.Tag valueOf(String name)
valuesback to summary
public static Tokens.Tag[] values()