myhw1

Class VideoObj

java.lang.Object

myhw1.VideoObj

All Implemented Interfaces:

java.lang.Comparable<VideoObj>

final class VideoObj
extends java.lang.Object
implements java.lang.Comparable<VideoObj>

Immutable Data Class for video objects. Comprises a triple: title, year, director.

Class Type: Immutable Data Class

Object Invariant:

Title is non-null, no leading or final spaces, not empty string.

Object Invariant:

Year is greater than 1800, less than 5000.

Object Invariant:

Director is non-null, no leading or final spaces, not empty string.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	director Invariant: non-null, no leading or final spaces, not empty string
private java.lang.String	title Invariant: non-null, no leading or final spaces, not empty string
private int	year Invariant: greater than 1800, less than 5000

Constructor Summary

Constructors

Constructor and Description
VideoObj(java.lang.String title, int year, java.lang.String director) Initialize all object attributes.

Method Summary

Modifier and Type	Method and Description
int	compareTo(VideoObj that) Compares the attributes of this object with those of thatObject, in the following order: title, year, director.
java.lang.String	director() Return the value of the attribute.
boolean	equals(java.lang.Object thatObject) Compare the attributes of this object with those of thatObject.
int	hashCode() Return a hash code value for this object using the algorithm from Bloch: fields are added in the following order: title, year, director.
java.lang.String	title() Return the value of the attribute.
java.lang.String	toString() Return a string representation of the object in the following format: "title (year) : director".
int	year() Return the value of the attribute.

Methods inherited from class java.lang.Object

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

Field Detail

title

private final java.lang.String title

Invariant: non-null, no leading or final spaces, not empty string

year

private final int year

Invariant: greater than 1800, less than 5000

director

private final java.lang.String director

Invariant: non-null, no leading or final spaces, not empty string

Constructor Detail

VideoObj

VideoObj(java.lang.String title,
         int year,
         java.lang.String director)

Initialize all object attributes. Title and director are "trimmed" to remove leading and final space.

Throws:

java.lang.IllegalArgumentException - if any object invariant is violated.

Method Detail

director

public java.lang.String director()

Return the value of the attribute.

title

public java.lang.String title()

Return the value of the attribute.

year

public int year()

Return the value of the attribute.

equals

public boolean equals(java.lang.Object thatObject)

Compare the attributes of this object with those of thatObject.

Overrides:

equals in class java.lang.Object

Parameters:

thatObject - the Object to be compared.

Returns:

deep equality test between this and thatObject.

hashCode

public int hashCode()

Return a hash code value for this object using the algorithm from Bloch: fields are added in the following order: title, year, director.

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(VideoObj that)

Compares the attributes of this object with those of thatObject, in the following order: title, year, director.

Specified by:

compareTo in interface java.lang.Comparable<VideoObj>

Parameters:

that - the VideoObj to be compared.

Returns:

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

toString

public java.lang.String toString()

Return a string representation of the object in the following format: "title (year) : director".

Overrides:

toString in class java.lang.Object