blob: 30b2771417dbde6fa09ec98ec8b97c9458b8dd73 [file] [log] [blame]
/*
* Copyright (c) 2010-2019 BSI Business Systems Integration AG.
* 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
*
* Contributors:
* BSI Business Systems Integration AG - initial API and implementation
*/
package org.eclipse.scout.rt.dataobject.id;
import java.util.UUID;
/**
* An interface to represent the unique universal id of an object. The raw (wrapped) id is of type {@link UUID}.
* <p>
* Subclasses must provide the following static factory methods:
* <ul>
* <li><b>create()</b>: used to create new ids (like a database sequence). The method is expected to return a new
* instance wrapping {@link UUID#randomUUID()}.
* <li><b>of(UUID)</b>: used by {@link IdFactory} to construct new instances. The method is expected to return
* <code>null</code> if the given {@link UUID} is <code>null</code>, otherwise the wrapped {@link UUID}.
* <li><b>of(String)</b>: used by {@link IdFactory} to construct new instances. The method is expected to return
* <code>null</code> if the given {@link String} is <code>null</code>, otherwise the wrapped {@link UUID}.
* </ul>
* This interface implements {@link Comparable} by comparing the wrapped {@link UUID} value, without considering the id
* types. Hence every {@link IUuId} is comparable to any other {@link IUuId}.
*/
public interface IUuId extends IId<UUID> {
}