org.jomc.model

Class JavaIdentifier

java.lang.Object

org.jomc.model.JavaIdentifier

All Implemented Interfaces:

Serializable, CharSequence

public final class JavaIdentifier
extends Object
implements CharSequence, Serializable

Data type of a Java identifier.

This class provides support for parsing and normalizing text to java identifiers as specified in the Java Language Specification - Java SE 7 Edition - Chapter 3.8ff.

Please note that this class will move to package org.jomc.util in JOMC 2.0.

Since:

1.4

Version:

$JOMC: JavaIdentifier.java 4962 2014-09-06 23:58:48Z schulte $

Author:

Christian Schulte

See Also:

normalize(java.lang.String, org.jomc.model.JavaIdentifier.NormalizationMode), parse(java.lang.String), valueOf(java.lang.String), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaIdentifier.NormalizationMode Normalization modes.

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index) Returns the char value at a given index.
boolean	equals(Object o) Tests whether some other object is equal to the object.
int	hashCode() Returns the hash-code value of the object.
int	length() Returns the length of this character sequence.
static JavaIdentifier	normalize(String text, JavaIdentifier.NormalizationMode mode) Normalizes text from the beginning of the given string to produce a JavaIdentifier.
static JavaIdentifier	parse(String text) Parses text from the beginning of a given string to produce a JavaIdentifier instance.
CharSequence	subSequence(int start, int end) Returns a new CharSequence that is a subsequence of this sequence.
String	toString() Returns a string containing the characters in this sequence in the same order as this sequence.
static JavaIdentifier	valueOf(String text) Parses text from the beginning of a given string to produce a JavaIdentifier instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

length

public int length()

Returns the length of this character sequence.

Specified by:

length in interface CharSequence

Returns:

The number of chars in this sequence.

charAt

public char charAt(int index)

Returns the char value at a given index.

Specified by:

charAt in interface CharSequence

Parameters:

index - The index of the char value to return.

Returns:

The char value at index.

Throws:

IndexOutOfBoundsException - if index is negative or not less than the length of the sequence.

subSequence

public CharSequence subSequence(int start,
                       int end)

Returns a new CharSequence that is a subsequence of this sequence.

Specified by:

subSequence in interface CharSequence

Parameters:

start - The start index, inclusive.

end - The end index, exclusive.

Returns:

The sequence of characters starting at index start up to index end - 1.

Throws:

IndexOutOfBoundsException - if start or end are negative, if end is greater than the length of the sequence, or if start is greater than end.

toString

public String toString()

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

A string consisting of exactly this sequence of characters.

hashCode

public int hashCode()

Returns the hash-code value of the object.

Overrides:

hashCode in class Object

Returns:

The hash-code value of the object.

equals

public boolean equals(Object o)

Tests whether some other object is equal to the object.

Overrides:

equals in class Object

Parameters:

o - The object to test.

Returns:

true, if o is an instance of the class of the object and its string value is equal to the string value of the object.

normalize

public static JavaIdentifier normalize(String text,
                       JavaIdentifier.NormalizationMode mode)
                                throws ParseException

Normalizes text from the beginning of the given string to produce a JavaIdentifier.

Parameters:

text - The text to normalize.

mode - The normalization to apply.

Returns:

A JavaIdentifier instance constructed by normalizing text according to mode.

Throws:

NullPointerException - if text or mode is null.

ParseException - if normalization fails.

parse

public static JavaIdentifier parse(String text)
                            throws ParseException

Parses text from the beginning of a given string to produce a JavaIdentifier instance.

Parameters:

text - The text to parse.

Returns:

A JavaIdentifier instance constructed by parsing text.

Throws:

NullPointerException - if text is null.

ParseException - if parsing fails.

See Also:

valueOf(java.lang.String)

valueOf

public static JavaIdentifier valueOf(String text)
                              throws IllegalArgumentException

Parses text from the beginning of a given string to produce a JavaIdentifier instance.

Unlike the parse(String) method, this method throws an IllegalArgumentException if parsing fails.

Parameters:

text - The text to parse.

Returns:

A JavaIdentifier instance constructed by parsing text.

Throws:

NullPointerException - if text is null.

IllegalArgumentException - if parsing fails.

See Also:

parse(java.lang.String)