Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.xpmtl.data
Class Tag  view Tag download Tag.java

java.lang.Object
  extended byorg.xpmtl.data.Tag

public class Tag
extends java.lang.Object


Field Summary
static java.lang.String CLOSING_TAG
           
static boolean DEBUG
           
static java.lang.String DOUBLE_QUOTE
           
private  boolean m_ClosingTag
           
private  java.lang.String m_Name
           
private  boolean m_OpeningTag
           
private  java.util.Hashtable m_Properties
           
static boolean NAME_ARE_CASE_SENSITIVE
           
static java.lang.String START_COMMENT
           
static java.lang.String START_TAG
           
static java.lang.String STOP_COMMENT
           
static java.lang.String STOP_TAG
           
static java.lang.String XML_START_TAG
           
 
Constructor Summary
Tag()
           
Tag(java.lang.String name, boolean opening, boolean closing)
           
 
Method Summary
 void addProperty(java.lang.String key, java.lang.String value)
           
 boolean equals(java.lang.Object elem)
          Determine whether this Object is semantically equal to another Object.
 java.lang.String getName()
           
 int getNbProperties()
           
(package private)  java.util.Hashtable getProperties()
           
 java.lang.String getProperty(java.lang.String propertyName)
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 boolean isAssociatedTag(Tag tag)
           
 boolean isClosingTag()
           
 boolean isOpeningTag()
           
 void setClosingTag(boolean b)
           
 void setName(java.lang.String s)
           
 void setOpeningTag(boolean b)
           
 java.lang.String toHuman(java.lang.String header)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

START_TAG

public static final java.lang.String START_TAG
See Also:
Constant Field Values

STOP_TAG

public static final java.lang.String STOP_TAG
See Also:
Constant Field Values

CLOSING_TAG

public static final java.lang.String CLOSING_TAG
See Also:
Constant Field Values

XML_START_TAG

public static final java.lang.String XML_START_TAG
See Also:
Constant Field Values

DOUBLE_QUOTE

public static final java.lang.String DOUBLE_QUOTE
See Also:
Constant Field Values

START_COMMENT

public static final java.lang.String START_COMMENT
See Also:
Constant Field Values

STOP_COMMENT

public static final java.lang.String STOP_COMMENT
See Also:
Constant Field Values

m_OpeningTag

private boolean m_OpeningTag

m_ClosingTag

private boolean m_ClosingTag

m_Name

private java.lang.String m_Name

m_Properties

private java.util.Hashtable m_Properties

DEBUG

public static boolean DEBUG

NAME_ARE_CASE_SENSITIVE

public static boolean NAME_ARE_CASE_SENSITIVE
Constructor Detail

Tag

public Tag()

Tag

public Tag(java.lang.String name,
           boolean opening,
           boolean closing)
Method Detail

setName

public void setName(java.lang.String s)

getName

public java.lang.String getName()

setOpeningTag

public void setOpeningTag(boolean b)

isOpeningTag

public boolean isOpeningTag()

setClosingTag

public void setClosingTag(boolean b)

isClosingTag

public boolean isClosingTag()

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
                             throws org.xpmtl.parser.PropertyUnknownException

getNbProperties

public int getNbProperties()

equals

public boolean equals(java.lang.Object elem)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


isAssociatedTag

public boolean isAssociatedTag(Tag tag)

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


toHuman

public java.lang.String toHuman(java.lang.String header)

getProperties

java.util.Hashtable getProperties()