com.orientechnologies.common.util.OPair Maven / Gradle / Ivy

/*
  *
  *  *  Copyright 2014 Orient Technologies LTD (info(at)orientechnologies.com)
  *  *
  *  *  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.
  *  *
  *  * For more information: http://www.orientechnologies.com
  *
  */
package com.orientechnologies.common.util;

import java.util.Arrays;
import java.util.Map.Entry;

/**
 * Keeps a pair of values as Key/Value.
 * 
 * @author Luca Garulli (l.garulli--at--orientechnologies.com)
 * 
 * @param 
 *          Key
 * @param 
 *          Value
 * @see OTriple
 */
public class OPair, V> implements Entry, Comparable> {
  public K key;
  public V value;

  public OPair() {
  }

  public OPair(final K iKey, final V iValue) {
    key = iKey;
    value = iValue;
  }

  public OPair(final Entry iSource) {
    key = iSource.getKey();
    value = iSource.getValue();
  }

  public void init(final K iKey, final V iValue) {
    key = iKey;
    value = iValue;
  }

  public K getKey() {
    return key;
  }

  public V getValue() {
    return value;
  }

  public V setValue(final V iValue) {
    V oldValue = value;
    value = iValue;
    return oldValue;
  }

  @Override
  public String toString() {
    final StringBuilder buffer = new StringBuilder(512);
    buffer.append(key);
    buffer.append(':');

    if (value == null || !value.getClass().isArray())
      buffer.append(value);
    else
      buffer.append(Arrays.toString((Object[]) value));

    return buffer.toString();
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((key == null) ? 0 : key.hashCode());
    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj)
      return true;
    if (obj == null)
      return false;
    if (getClass() != obj.getClass())
      return false;
    OPair other = (OPair) obj;
    if (key == null) {
      if (other.key != null)
        return false;
    } else if (!key.equals(other.key))
      return false;
    return true;
  }

  public int compareTo(final OPair o) {
    return key.compareTo(o.key);
  }
}