com.googlecode.jfilechooserbookmarks

Class Bookmark

java.lang.Object

com.googlecode.jfilechooserbookmarks.Bookmark

All Implemented Interfaces:

Serializable, Comparable<Bookmark>

public class Bookmark
extends Object
implements Serializable, Comparable<Bookmark>

Represents a single filechooser bookmark.

Version:

$Revision: 8361 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected File	m_Directory the associated directory.
protected String	m_Name the name of the bookmark.

Constructor Summary

Constructors

Constructor and Description
Bookmark(File dir) Initializes the bookmark with the given directory.
Bookmark(String name, File dir) Initializes the bookmark with the given directory.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Bookmark o) Compares this object with the specified object for order.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
File	getDirectory() Returns the associated directory of the bookmark.
String	getName() Returns the name of the bookmark.
String	toString() Returns the name.

Methods inherited from class java.lang.Object

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

Field Detail

m_Name

protected String m_Name

the name of the bookmark.

m_Directory

protected File m_Directory

the associated directory.

Constructor Detail

Bookmark

public Bookmark(File dir)

Initializes the bookmark with the given directory. Uses the directory's name as name for the bookmark.

Parameters:

dir - the directory to use

Bookmark

public Bookmark(String name,
                File dir)

Initializes the bookmark with the given directory.

Parameters:

name - the name of the bookmark

dir - the directory to use

Method Detail

getName

public String getName()

Returns the name of the bookmark.

Returns:

the name

getDirectory

public File getDirectory()

Returns the associated directory of the bookmark.

Returns:

the directory

compareTo

public int compareTo(Bookmark o)

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.

Only uses the name for comparison.

Specified by:

compareTo in interface Comparable<Bookmark>

Parameters:

o - the object to be compared.

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(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

toString

public String toString()

Returns the name.

Overrides:

toString in class Object

Returns:

the name