com.cedarsoft.file.BaseName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of file Show documentation
The newest version!
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.file;


import org.jetbrains.annotations.NotNull;

import javax.annotation.Nonnull;
import java.io.Serializable;

/**
 * A base name of a file
 *
 * @author Johannes Schneider ([email protected])
 */
public class BaseName implements Comparable, Serializable {
  @Nonnull
  private final String name;

  /**
   * Creates a new base name
   *
   * @param name the name
   */
  public BaseName( @Nonnull String name ) {
    this.name = name;
  }

  /**
   * Getter for the field {@code name}.
   *
   * @return a String object.
   */
  @Nonnull
  public String getName() {
    return name;
  }

  @Override
  public String toString() {
    return name;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (!(obj instanceof BaseName)) {
      return false;
    }

    BaseName baseName = (BaseName) obj;

    if (!name.equals(baseName.name)) {
      return false;
    }

    return true;
  }

  @Override
  public int hashCode() {
    return name.hashCode();
  }

  @Override
  public int compareTo(@NotNull BaseName o) {
    return name.compareTo( o.name );
  }
}