blob: 028b5acbc1516dd6e589fde9b2512f83651bb325 [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;
/**
* An interface to represent a {@code String}-based id.
* <p>
* Subclasses must provide the following static factory methods:
* <ul>
* <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 String}.
* </ul>
* This interface implements {@link Comparable} by comparing the wrapped {@link String} value, without considering the
* id types. Hence every {@link IStringId} is comparable to any other {@link IStringId}.
*/
public interface IStringId extends IId<String> {
}