it.tidalwave.util.Key Maven / Gradle / Ivy
/***********************************************************************************************************************
*
* blueBill Mobile - open source birdwatching
* ==========================================
*
* Copyright (C) 2009, 2010 by Tidalwave s.a.s. (http://www.tidalwave.it)
* http://bluebill.tidalwave.it/mobile/
*
***********************************************************************************************************************
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
***********************************************************************************************************************
*
* $Id: Key.java,v ad88e9950c23 2010/06/21 11:14:44 fabrizio $
*
**********************************************************************************************************************/
package it.tidalwave.util;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
/***********************************************************************************************************************
*
* @author Fabrizio Giudici
* @version $Id: $
*
**********************************************************************************************************************/
public final class Key implements StringValue, Comparable>
{
@Nonnull
private final String name;
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
public Key (final @Nonnull String name)
{
this.name = name;
}
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
@Override @Nonnull
public String stringValue()
{
return name;
}
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
@Override
public int compareTo (final @Nonnull Key other)
{
return this.name.compareTo(other.name);
}
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
@Override
public boolean equals (final @CheckForNull Object other)
{
return (other != null)
&& (other instanceof Key)
&& this.name.equals(((Key)other).name);
}
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
@Override
public int hashCode()
{
return name.hashCode();
}
/*******************************************************************************************************************
*
*
******************************************************************************************************************/
@Override @Nonnull
public String toString()
{
return String.format("Key[%s]", name);
}
}