FamousName

Class FamousName

java.lang.Object
  FamousName

FamousName is the first name of a famous person. It is a special kind of string of length > 1 that contains only uppercase alphabetic characters.

Constructor Summary
`FamousName()` Construct an empty name.
`FamousName(java.lang.String rawname)` Construct a FamousName from a string.

Method Summary
`int`	`compareTo(FamousName val)` Compares this FamousName with the provided FamousName.
`boolean`	`equals(java.lang.Object other)` Compare two FamousNames for equality.
`static boolean`	`isLegalName(java.lang.String rawname)` Determine if a string is a legal name.
`java.lang.String`	`toString()` Return a string representation of this FamousName

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

public FamousName()

Construct an empty name.

public FamousName(java.lang.String rawname)

Construct a FamousName from a string.

Parameters:: rawname - a String to be assigned to this FamousName
Postcondition:: if isLegalName(rawname) then a FamousName is created from rawname otherwise an empty FamousName is created.

Method Detail

public static boolean isLegalName(java.lang.String rawname)

Determine if a string is a legal name.

Parameters:: rawname - a string to be evaluated for validity
Returns:: true if all characters in rawname are alphabetic and the length > 1.

public int compareTo(FamousName val)

Compares this FamousName with the provided FamousName.

Parameters:: val - FamousName to which this FamousName is to be compared.
Returns:: -1, 0 or 1 as this FamousName is alphabetically less than, equal to, or greater than val.

public boolean equals(java.lang.Object other)

Compare two FamousNames for equality. This method is provided to facilitate JUnit testing.

public java.lang.String toString()

Return a string representation of this FamousName