org.jfree.report.modules.parser.base
Class CommentHintPath

java.lang.Object
  org.jfree.report.modules.parser.base.CommentHintPath

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public final class CommentHintPath

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

The comment hint path is used to mark the parse position and to store the comments for such an parser path.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

CommentHintPath()
Creates a new empty comment hint path object.

CommentHintPath(java.lang.Object name)
Creates a new comment hint path and adds the given object as first name segment.

CommentHintPath(java.lang.Object[] name)
Creates a new comment hint path and adds the given objects as name segments.

Method Summary

void	addName(java.lang.Object name) Appends the given object as last element to the path.
boolean	equals(java.lang.Object o) Tests, whether this object is equal to the given object.
CommentHintPath	getInstance() Returns a copy of this comment hint path.
int	hashCode() Computes a hashcode for this path.
java.lang.String	toString() Returns a string representation of this object for debugging purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentHintPath

public CommentHintPath()

Creates a new empty comment hint path object.

CommentHintPath

public CommentHintPath(java.lang.Object name)

Creates a new comment hint path and adds the given object as first name segment.

Parameters:

name - the first name segment.

CommentHintPath

public CommentHintPath(java.lang.Object[] name)

Creates a new comment hint path and adds the given objects as name segments.

Parameters:

name - the name segments.

Method Detail

addName

public void addName(java.lang.Object name)

Appends the given object as last element to the path.

Parameters:

name - the new path segment.

getInstance

public CommentHintPath getInstance()

Returns a copy of this comment hint path.

Returns:

a copy of this path.

equals

public boolean equals(java.lang.Object o)

Tests, whether this object is equal to the given object.

Parameters:

o - the object that should be compared.

Returns:

true, if the other object is equal, false otherwise.

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Computes a hashcode for this path.

Returns:

a hashcode for this object.

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Returns a string representation of this object for debugging purposes.

Returns:

the object as string.

See Also:

Object.toString()