sbrt.shell.io
Class EndOfFile

java.lang.Object
  extended by sbrt.shell.io.EndOfFile
All Implemented Interfaces:
java.io.Serializable

public final class EndOfFile
extends java.lang.Object
implements java.io.Serializable

This class is used to represent end-of-file (EOF).

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.
See Also:
Serialized Form

Method Summary
 boolean equals(java.lang.Object obj)
          Indicates if the provided object is equal to this end-of-file.
static EndOfFile get()
          Returns an instance of this class.
 int hashCode()
          Returns 0.
static boolean isEof(java.lang.Object obj)
          Indicates if the provided object is an instance of this class.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public static EndOfFile get()
Returns an instance of this class.

Returns:
an instance of this class.

isEof

public static final boolean isEof(java.lang.Object obj)
Indicates if the provided object is an instance of this class.

Parameters:
obj - the reference object with which to compare.
Returns:
true if the provided object is an instance of this class; false otherwise.

equals

public boolean equals(java.lang.Object obj)
Indicates if the provided object is equal to this end-of-file.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if the provided object is an instance of this class; false otherwise.

hashCode

public int hashCode()
Returns 0.

Overrides:
hashCode in class java.lang.Object
Returns:
0.