org.opendaylight.yangtools.concepts.Identifier Maven / Gradle / Ivy
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.concepts;
import java.io.Serializable;
/**
* General identifier interface. It is primarily a marker for all things that identify concepts -- such as names,
* addresses, classes, etc. We do not require too much, just that the identifiers are serializable (and thus
* transferable).
*
* Implementations are expected to implement {@link #hashCode()} and {@link #equals(Object)} methods in a way,
* which ensures that objects before and after serialization are considered equal.
*
*
Implementations are advised to use the {@link java.io.Externalizable} Proxy pattern to allow future evolution
* of their serialization format. For further efficiency, implementations should consider implementing
* {@link WritableObject}, so they can be efficiently embedded in other {@link Serializable} and {@code WritableObject}s
* objects.
*/
public interface Identifier extends Serializable, Immutable {
@Override
boolean equals(Object obj);
@Override
int hashCode();
@Override
String toString();
}