wamblee.org Git - xmlrouter/blob - config/src/main/java/org/wamblee/xmlrouter/config/Identifiable.java

   1 /*
   2  * Copyright 2005-2011 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.xmlrouter.config;
  17
  18 import org.wamblee.xmlrouter.common.Id;
  19
  20 /**
  21  * Classes implementing this interface must provide a unique id to identify
  22  * their contents and behavior. If the content or behavior of an object changes,
  23  * then a different id should be returned. Conversely, it is required for the id
  24  * to keep as constant as possible. Also, a given object should return the same
  25  * id throughout its lifecycle (from the moment it's {@link #getId()} method is
  26  * called until the moment it can no longer be referenced.
  27  *
  28  * @author Erik Brakkee
  29  *
  30  */
  31 public interface Identifiable<T> {
  32
  33     /**
  34      * Returns the unique id for the object.
  35      *
  36      * @return Unique id.
  37      */
  38     Id<T> getId();
  39 }