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

Quick Search    Search Deep

com.clra.rowing
Class RowingSessionLevel  view RowingSessionLevel download RowingSessionLevel.java

java.lang.Object
  extended bycom.clra.rowing.RowingSessionLevel
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class RowingSessionLevel
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable

Represents the level of a rowing session.

Version:
$Id: RowingSessionLevel.java,v 1.3 2003/02/26 03:38:45 rphall Exp $

Field Summary
static RowingSessionLevel LTR
           
private  java.lang.String name
           
static java.lang.String NAME_LTR
           
static java.lang.String NAME_REGULAR
           
static RowingSessionLevel REGULAR
           
 
Constructor Summary
protected RowingSessionLevel(java.lang.String name)
           
 
Method Summary
 int compareTo(java.lang.Object o)
          Compares a level to other levels and valid level names.
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
static RowingSessionLevel getLevel(java.lang.String name)
           
 java.lang.String getName()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 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

NAME_LTR

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

NAME_REGULAR

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

LTR

public static final RowingSessionLevel LTR

REGULAR

public static final RowingSessionLevel REGULAR

name

private final java.lang.String name
Constructor Detail

RowingSessionLevel

protected RowingSessionLevel(java.lang.String name)
Method Detail

getLevel

public static RowingSessionLevel getLevel(java.lang.String name)
                                   throws RowingException

getName

public java.lang.String getName()

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()).


equals

public boolean equals(java.lang.Object o)
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)


compareTo

public int compareTo(java.lang.Object o)
Compares a level to other levels and valid level names. The default order is described in the documentation for DefaultRowingSessionLevelComparator

Specified by:
compareTo in interface java.lang.Comparable