/**
 *  ServingXML
 *  
 *  Copyright (C) 2006  Daniel Parker
 *    daniel.parker@servingxml.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. 
 * 
 **/

package com.servingxml.components.content.dynamic;

/**
 * This interface defines an equality relation between two keys.
 *
 * 
 * @author Daniel A. Parker (daniel.parker@servingxml.com)
 */

public interface KeyIdentifier extends Identifier {
  String[] getSegmentNames();

  /**
   * Compares the two key arguments for equality.  Returns true or false
   * depending on whether the two key arguments are equal.<p>
   *
   * @param key1 the first key object to be compared.
   * @param key2 the second key object to be compared.
   * @return <code>true</code> or <false> depending on whether the two key
   * arguments are equal.
   */
  boolean equalTo(Object key1, Object key2);
}
