com.microsoft.reef.io.network.util.StringIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reef-io Show documentation

There is a newer version: 0.9

/**
 * Copyright (C) 2013 Microsoft Corporation
 *
 * 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.
 */
package com.microsoft.reef.io.network.util;

import com.microsoft.wake.ComparableIdentifier;
import com.microsoft.wake.Identifier;

/**
 * String identifier
 */
public class StringIdentifier implements ComparableIdentifier {
  
  private final String str;
  
  /**
   * Constructs a string identifier
   * 
   * @param str a string
   */
  StringIdentifier(String str) {
    this.str = str;
  }
  
  /**
   * Returns a hash code for the object
   * 
   * @return a hash code value for this object
   */
  public int hashCode() {
    return str.hashCode();
  }
  
  /**
   * Checks that another object is equal to this object
   * 
   * @param o another object
   * @return true if the object is the same as the object argument; false, otherwise
   */
  public boolean equals(Object o) {
    return str.equals(((StringIdentifier)o).toString());
  }
  
  /**
   * Returns a string representation of the object
   * 
   * @return a string representation of the object
   */
  public String toString() {
    return str;
  }

  @Override
  public int compareTo(Identifier o) {
	if(o==null){
		if(str==null)
			return 0;
		return 1;
	}
	else{
		if(str==null)
			return -1;
		return str.compareTo(o.toString());
	}
  }
}