org.jboss.cache
Class Fqn

java.lang.Object
  |
  +--org.jboss.cache.Fqn

All Implemented Interfaces:

java.lang.Cloneable, java.io.Externalizable, java.io.Serializable

public class Fqn

extends java.lang.Object

implements java.lang.Cloneable, java.io.Externalizable

Fully qualified name. Essentially a list of relative names, from root to a given node. This class is immutable.

Version:

$Revision: 1.12.12.2 $

See Also:

Serialized Form

Constructor Summary

Fqn()

Fqn(Fqn base, Fqn relative)

Fqn(Fqn base, java.util.List relative)

Fqn(Fqn base, java.lang.Object relative_name)

Fqn(Fqn base, java.lang.Object relative_name1, java.lang.Object relative_name2)

Fqn(Fqn base, java.lang.Object relative_name1, java.lang.Object relative_name2, java.lang.Object relative_name3)

Fqn(java.util.List names)

Fqn(java.lang.Object name)

Fqn(java.lang.Object[] names)

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
static Fqn	fromString(java.lang.String fqn)
java.lang.Object	get(int index)
Fqn	getFqnChild(int index) Obtain a child Fqn from a sub-index.
Fqn	getFqnChild(int startIndex, int endIndex)
Fqn	getParent()
int	hashCode()
boolean	isChildOf(Fqn parentFqn) Check if current fqn is child of parentFqn
boolean	isRoot()
void	readExternal(java.io.ObjectInput in)
int	size()
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Fqn

public Fqn()

Fqn

public Fqn(java.lang.Object name)

Fqn

public Fqn(java.util.List names)

Fqn

public Fqn(java.lang.Object[] names)

Fqn

public Fqn(Fqn base,
           java.lang.Object relative_name)

Fqn

public Fqn(Fqn base,
           Fqn relative)

Fqn

public Fqn(Fqn base,
           java.util.List relative)

Fqn

public Fqn(Fqn base,
           java.lang.Object relative_name1,
           java.lang.Object relative_name2)

Fqn

public Fqn(Fqn base,
           java.lang.Object relative_name1,
           java.lang.Object relative_name2,
           java.lang.Object relative_name3)

Method Detail

fromString

public static Fqn fromString(java.lang.String fqn)

getFqnChild

public Fqn getFqnChild(int index)

Obtain a child Fqn from a sub-index.

Parameters:

index - where is the last index of child fqn

Returns:

A Fqn child object.

getFqnChild

public Fqn getFqnChild(int startIndex,
                       int endIndex)

size

public int size()

get

public java.lang.Object get(int index)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

java.io.IOException

java.lang.ClassNotFoundException

isChildOf

public boolean isChildOf(Fqn parentFqn)

Check if current fqn is child of parentFqn

Parameters:

parentFqn -

Returns:

getParent

public Fqn getParent()

isRoot

public boolean isRoot()