Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> clra >> [ rowing overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.clra.rowing
Class SeatPreference  

java.lang.Object
  com.clra.rowing.SeatPreference

All Implemented Interfaces:

java.io.Serializable

---

public class SeatPreference

extends java.lang.Object

implements java.io.Serializable

Defines seating preference that may be specified by a participant for a rowing session.

Version:

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

---

Field Summary
static SeatPreference	COX           Indicates a member prefers to cox.
private  java.lang.String	name
static java.lang.String	NAME_COX           Indicates a member prefers to cox.
static java.lang.String	NAME_PORT           Indicates a member prefers a port rowing position
static java.lang.String	NAME_PORT_THEN_STARBOARD           Indicates a member prefers a port position, but will also row starboard.
static java.lang.String	NAME_STARBOARD           Indicates a member prefers a starboard rowing position
static java.lang.String	NAME_STARBOARD_THEN_PORT           Indicates a member prefers a starboard position, but will also row port.
static SeatPreference	PORT           Indicates a member prefers a port rowing position
static SeatPreference	PORT_THEN_STARBOARD           Indicates a member prefers a port position, but will also row starboard.
static SeatPreference	STARBOARD           Indicates a member prefers a starboard rowing position
static SeatPreference	STARBOARD_THEN_PORT           Indicates a member prefers a starboard position, but will also row port.

 

Constructor Summary
protected	SeatPreference(java.lang.String name)

 

Method Summary
static boolean	compare(java.lang.String s1, java.lang.String s2)
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
java.lang.String	getName()
static SeatPreference	getSeatPreference(java.lang.String name)           SeatPreference is not a required field in a participant record, therefore if a null or blank name is passed to this method, an IllegalArgumentException is NOT thrown, but rather a null instance is returned.
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_STARBOARD

public static final java.lang.String NAME_STARBOARD

Indicates a member prefers a starboard rowing position

See Also:

Constant Field Values

---

NAME_PORT

public static final java.lang.String NAME_PORT

Indicates a member prefers a port rowing position

See Also:

Constant Field Values

---

NAME_STARBOARD_THEN_PORT

public static final java.lang.String NAME_STARBOARD_THEN_PORT

Indicates a member prefers a starboard position, but will also row port.

See Also:

Constant Field Values

---

NAME_PORT_THEN_STARBOARD

public static final java.lang.String NAME_PORT_THEN_STARBOARD

Indicates a member prefers a port position, but will also row starboard.

See Also:

Constant Field Values

---

NAME_COX

public static final java.lang.String NAME_COX

Indicates a member prefers to cox.

See Also:

Constant Field Values

---

STARBOARD

public static final SeatPreference STARBOARD

Indicates a member prefers a starboard rowing position

---

PORT

public static final SeatPreference PORT

Indicates a member prefers a port rowing position

---

STARBOARD_THEN_PORT

public static final SeatPreference STARBOARD_THEN_PORT

Indicates a member prefers a starboard position, but will also row port.

---

PORT_THEN_STARBOARD

public static final SeatPreference PORT_THEN_STARBOARD

Indicates a member prefers a port position, but will also row starboard.

---

COX

public static final SeatPreference COX

Indicates a member prefers to cox.

---

name

private final java.lang.String name

Constructor Detail

SeatPreference

protected SeatPreference(java.lang.String name)

Method Detail

getSeatPreference

public static SeatPreference getSeatPreference(java.lang.String name)
                                        throws RowingException

SeatPreference is not a required field in a participant record, therefore if a null or blank name is passed to this method, an IllegalArgumentException is NOT thrown, but rather a null instance is returned.

Note: values not defined by this class, will throw a 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()).

---

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)

---

compare

public static boolean compare(java.lang.String s1,
                              java.lang.String s2)

---

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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> clra >> [ rowing overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---