com.googlecode.jfilechooserbookmarks.Bookmark Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfilechooser-bookmarks Show documentation
Directory bookmarks for the JFileChooser Swing component.
There is a newer version: 0.1.9
Show newest version
/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/**
 * FileChooserBookmark.java
 * Copyright (C) 2013-2014 University of Waikato, Hamilton, New Zealand
 */
package com.googlecode.jfilechooserbookmarks;

import java.io.File;
import java.io.Serializable;

/**
 * Represents a single filechooser bookmark.
 * 
 * @author  fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 8361 $
 */
public class Bookmark
  implements Serializable, Comparable {
  
  /** for serialization. */
  private static final long serialVersionUID = 4284430561284693010L;

  /** the name of the bookmark. */
  protected String m_Name;
  
  /** the associated directory. */
  protected File m_Directory;
  
  /**
   * Initializes the bookmark with the given directory. Uses the directory's
   * name as name for the bookmark.
   * 
   * @param dir	the directory to use
   */
  public Bookmark(File dir) {
    this(dir.getAbsoluteFile().getName(), dir);
  }
  
  /**
   * Initializes the bookmark with the given directory.
   * 
   * @param name	the name of the bookmark
   * @param dir	the directory to use
   */
  public Bookmark(String name, File dir) {
    if ((name == null) || name.isEmpty())
      throw new IllegalArgumentException("Name cannot be null or empty!");
    if (dir == null)
      throw new IllegalArgumentException("Directory cannot be null!");
    
    m_Name      = name;
    m_Directory = dir;
  }    
  
  /**
   * Returns the name of the bookmark.
   * 
   * @return		the name
   */
  public String getName() {
    return m_Name;
  }
  
  /**
   * Returns the associated directory of the bookmark.
   * 
   * @return		the directory
   */
  public File getDirectory() {
    return m_Directory;
  }

  /**
   * 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.
   *
   * @param   o the object to be compared.
   * @return  a negative integer, zero, or a positive integer as this object
   *		is less than, equal to, or greater than the specified object.
   */
  @Override
  public int compareTo(Bookmark o) {
    return getName().compareTo(o.getName());
  }

  /**
   * Indicates whether some other object is "equal to" this one.
   *
   * @param   obj   the reference object with which to compare.
   * @return  true if this object is the same as the obj
   *          argument; false otherwise.
   */
  @Override
  public boolean equals(Object obj) {
    if (obj instanceof Bookmark)
      return (compareTo((Bookmark) obj) == 0);
    else
      return false;
  }
  
  /**
   * Returns the name.
   * 
   * @return		the name
   */
  @Override
  public String toString() {
    return m_Name;
  }
}