us.bpsm.edn

Class Symbol

java.lang.Object

us.bpsm.edn.Symbol

All Implemented Interfaces:

java.lang.Comparable<Symbol>, Named

public final class Symbol
extends java.lang.Object
implements Named, java.lang.Comparable<Symbol>

A Symbol is Named. Additionally it obeys the syntactic restrictions defined for edn Symbols.

Field Summary

Fields inherited from interface us.bpsm.edn.Named

EMPTY

Method Summary

Modifier and Type	Method and Description
int	compareTo(Symbol right)
boolean	equals(java.lang.Object obj)
java.lang.String	getName() The name of this named thing, not including any prefix.
java.lang.String	getPrefix() The prefix, (also called namespace), which may be empty.
int	hashCode()
static Symbol	newSymbol(java.lang.String name) Equivalent to newSymbol("", name).
static Symbol	newSymbol(java.lang.String prefix, java.lang.String name) Provide a Symbol with the given prefix and name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPrefix

public final java.lang.String getPrefix()

The prefix, (also called namespace), which may be empty. A Named object with an empty prefix is said to have no prefix.

Specified by:

getPrefix in interface Named

Returns:

a possibly empty string; never null.

getName

public final java.lang.String getName()

The name of this named thing, not including any prefix.

Specified by:

getName in interface Named

Returns:

a non-empty string.

newSymbol

public static Symbol newSymbol(java.lang.String prefix,
                               java.lang.String name)

Provide a Symbol with the given prefix and name.

Parameters:

prefix - An empty String or a non-empty String obeying the restrictions specified by edn. Never null.

name - A non-empty string obeying the restrictions specified by edn. Never null.

Returns:

a Symbol, never null.

newSymbol

public static Symbol newSymbol(java.lang.String name)

Equivalent to newSymbol("", name).

Parameters:

name - A non-empty string obeying the restrictions specified by edn. Never null.

Returns:

a Symbol with the given name and no prefix.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Symbol right)

Specified by:

compareTo in interface java.lang.Comparable<Symbol>