net.sf.xtvdclient.xtvd.datatypes
Class StarRating

java.lang.Object
  net.sf.xtvdclient.xtvd.datatypes.StarRating

All Implemented Interfaces:

java.lang.Comparable

public class StarRating
extends java.lang.Object
implements java.lang.Comparable

A ordinal-based typesafe enum class that represents the pre-defined values for tms:starRating as defined in the XTVD schema.

Since:

ddclient 1.2

Copyright 2004, Tribune Media Services

$Id: StarRating.java,v 1.4 2004/03/26 15:56:16 rakesh Exp $

Field Summary

static StarRating	FOUR_STAR The typesafe representation of the **** starRating.
static StarRating	ONE_AND_HALF_STAR The typesafe representation of the *+ starRating.
static StarRating	ONE_STAR The typesafe representation of the * starRating.
static StarRating	THREE_AND_HALF_STAR The typesafe representation of the ***+ starRating.
static StarRating	THREE_STAR The typesafe representation of the *** starRating.
static StarRating	TWO_AND_HALF_STAR The typesafe representation of the **+ starRating.
static StarRating	TWO_STAR The typesafe representation of the ** starRating.

Method Summary

int	compareTo(java.lang.Object object) Implementation of the Comparable interface.
boolean	equals(java.lang.Object object) Indicates whether some other object is "equal to" this one.
static StarRating	getStarRating(java.lang.String rating) Return the appropriate StarRating based upon the string specified.
int	hashCode() Returns a hash code value for this class.
java.lang.String	toString() Over-ridden to return the value of rating.

Methods inherited from class java.lang.Object

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

Field Detail

ONE_STAR

public static final StarRating ONE_STAR

The typesafe representation of the * starRating.

ONE_AND_HALF_STAR

public static final StarRating ONE_AND_HALF_STAR

The typesafe representation of the *+ starRating.

TWO_STAR

public static final StarRating TWO_STAR

The typesafe representation of the ** starRating.

TWO_AND_HALF_STAR

public static final StarRating TWO_AND_HALF_STAR

The typesafe representation of the **+ starRating.

THREE_STAR

public static final StarRating THREE_STAR

The typesafe representation of the *** starRating.

THREE_AND_HALF_STAR

public static final StarRating THREE_AND_HALF_STAR

The typesafe representation of the ***+ starRating.

FOUR_STAR

public static final StarRating FOUR_STAR

The typesafe representation of the **** starRating.

Method Detail

getStarRating

public static StarRating getStarRating(java.lang.String rating)

Return the appropriate StarRating based upon the string specified. If the appropriate tv rating does not exist return null.

Parameters:

rating - The rating value that is to be used to fetch the corresponding StarRating.

Returns:

The appropriate instance if a corresponding instance is found, null otherwise.

toString

public java.lang.String toString()

Over-ridden to return the value of rating.

Overrides:

toString in class java.lang.Object

Returns:

String - The string representation of this class instance.

compareTo

public int compareTo(java.lang.Object object)

Implementation of the Comparable interface. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - The object with which this class is to be compared. No class type checking is done.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(java.lang.Object object)

Indicates whether some other object is "equal to" this one. Returns true if the specified object is of the same class type, and has the same ordinal value.

Overrides:

equals in class java.lang.Object

Parameters:

object - The reference object with which to compare.

Returns:

Return true if the match succeeds.

hashCode

public int hashCode()

Returns a hash code value for this class. Return the value of ordinal.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for the object.