Top Description Inners Constructors Methods
org.antlr.v4.misc

public abstract Class EscapeSequenceParsing

extends Object
Class Inheritance
Imports
org.antlr.v4.runtime.misc.IntervalSet, org.antlr.v4.unicode.UnicodeData, java.util.Objects

Utility class to parse escapes like: \\n \\uABCD \\u{10ABCD} \\p{Foo} \\P{Bar} \\p{Baz=Blech} \\P{Baz=Blech}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private static EscapeSequenceParsing.Result
invalid(int start, int stop)

public static EscapeSequenceParsing.Result
parseEscape(String s, int startOff)

Parses a single escape sequence starting at startOff.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

EscapeSequenceParsingback to summary
public EscapeSequenceParsing()

Method Detail

invalidback to summary
private static EscapeSequenceParsing.Result invalid(int start, int stop)
parseEscapeback to summary
public static EscapeSequenceParsing.Result parseEscape(String s, int startOff)

Parses a single escape sequence starting at startOff. Returns a type of INVALID if no valid escape sequence was found, a Result otherwise.

org.antlr.v4.misc back to summary

public Class EscapeSequenceParsing.Result

extends Object
Class Inheritance

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
public final int
public final int
public final IntervalSet
public final int
public final EscapeSequenceParsing.Result.Type

Constructor Summary

AccessConstructor and Description
public
Result(EscapeSequenceParsing.Result.Type type, int codePoint, IntervalSet propertyIntervalSet, int startOffset, int parseLength)

Method Summary

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

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

codePointback to summary
public final int codePoint
parseLengthback to summary
public final int parseLength
propertyIntervalSetback to summary
public final IntervalSet propertyIntervalSet
startOffsetback to summary
public final int startOffset
typeback to summary
public final EscapeSequenceParsing.Result.Type type

Constructor Detail

Resultback to summary
public Result(EscapeSequenceParsing.Result.Type type, int codePoint, IntervalSet propertyIntervalSet, int startOffset, int parseLength)

Method Detail

equalsback to summary
public boolean equals(Object other)

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
other: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
org.antlr.v4.misc back to summary

public final Enum EscapeSequenceParsing.Result.Type

extends Enum<EscapeSequenceParsing.Result.Type>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final EscapeSequenceParsing.Result.Type
public static final EscapeSequenceParsing.Result.Type
public static final EscapeSequenceParsing.Result.Type

Constructor Summary

AccessConstructor and Description
private
Type()

Field Detail

CODE_POINTback to summary
public static final EscapeSequenceParsing.Result.Type CODE_POINT
INVALIDback to summary
public static final EscapeSequenceParsing.Result.Type INVALID
PROPERTYback to summary
public static final EscapeSequenceParsing.Result.Type PROPERTY

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static EscapeSequenceParsing.Result.Type valueOf(String name)
valuesback to summary
public static EscapeSequenceParsing.Result.Type[] values()