concepts/src/main/java/org/opendaylight/protocol/concepts/NamedObject.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.protocol.concepts;
   9
  10 /**
  11  * General interface for identifyiable objects. Useful when you have an object
  12  * which has a sense of identity -- by having a "name".
  13  *
  14  * @param <T> template reference to the object name's Identifier class
  15  */
  16 public interface NamedObject<T extends Identifier> {
  17         /**
  18          * Get the object's Identifier (or "name"). A name uniquely identifies
  19          * an object among its peers. Two named objects can have the same
  20          * identifier, but need not necessarily be equal.
  21          *
  22          * @return The object's identifier
  23          */
  24         public T getName();
  25 }
  26