org.springframework.roo.model
Class JavaSymbolName

java.lang.Object
  org.springframework.roo.model.JavaSymbolName

All Implemented Interfaces:

Comparable<JavaSymbolName>

public final class JavaSymbolName
extends Object
implements Comparable<JavaSymbolName>

Immutable representation of a Java field name, method name, or other common legal Java identifier.

Ensures the field is properly formed.

Since:

1.0

Author:

Ben Alex

Constructor Summary

JavaSymbolName(String symbolName)
Construct a Java symbol name.

Method Summary

static void	assertJavaNameLegal(String name) Verifies the presented name is a valid Java name.
int	compareTo(JavaSymbolName o)
boolean	equals(Object obj)
String	getReadableSymbolName()
String	getSymbolName()
String	getSymbolNameCapitalisedFirstLetter()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaSymbolName

public JavaSymbolName(String symbolName)

Construct a Java symbol name.

The name will be enforced as follows:

• The rules listed in {link JavaTypeUtils#assertJavaNameLegal(String)}

Parameters:

symbolName - the name (mandatory)

Method Detail

getSymbolName

public String getSymbolName()

Returns:

the symbol name (never null or empty)

getSymbolNameCapitalisedFirstLetter

public String getSymbolNameCapitalisedFirstLetter()

Returns:

the symbol name, capitalising the first letter (never null or empty)

getReadableSymbolName

public String getReadableSymbolName()

Returns:

the symbol name in human readable form

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public final int compareTo(JavaSymbolName o)

Specified by:

compareTo in interface Comparable<JavaSymbolName>

toString

public final String toString()

Overrides:

toString in class Object

assertJavaNameLegal

public static final void assertJavaNameLegal(String name)

Verifies the presented name is a valid Java name. Specifically, the following is enforced:

• Textual content must be provided in the name
• Must not have any slashes in the name
• Must not start with a number
• Must not have any spaces or other illegal characters in the name
• Must not start or end with a period

Parameters:

name - to evaluate (required)