HRegionLocation.java

/**
 * Copyright 2007 The Apache Software Foundation
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hadoop.hbase;

/**
 * Contains the HRegionInfo for the region and the HServerAddress for the
 * HRegionServer serving the region
 */
public class HRegionLocation implements Comparable<HRegionLocation> {
  // TODO: Is this class necessary?  Why not just have a Pair?
  private HRegionInfo regionInfo;
  private HServerAddress serverAddress;

  /**
   * Constructor
   *
   * @param regionInfo the HRegionInfo for the region
   * @param serverAddress the HServerAddress for the region server
   */
  public HRegionLocation(HRegionInfo regionInfo, HServerAddress serverAddress) {
    this.regionInfo = regionInfo;
    this.serverAddress = serverAddress;
  }

  /**
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString() {
    return "address: " + this.serverAddress.toString() + ", regioninfo: " +
      this.regionInfo.getRegionNameAsString();
  }

  /**
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null) {
      return false;
    }
    if (!(o instanceof HRegionLocation)) {
      return false;
    }
    return this.compareTo((HRegionLocation)o) == 0;
  }

  /**
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    int result = this.regionInfo.hashCode();
    result ^= this.serverAddress.hashCode();
    return result;
  }

  /** @return HRegionInfo */
  public HRegionInfo getRegionInfo(){
    return regionInfo;
  }

  /** @return HServerAddress */
  public HServerAddress getServerAddress(){
    return serverAddress;
  }

  //
  // Comparable
  //

  public int compareTo(HRegionLocation o) {
    int result = this.regionInfo.compareTo(o.regionInfo);
    if(result == 0) {
      result = this.serverAddress.compareTo(o.serverAddress);
    }
    return result;
  }
}