Package org.forgerock.api.models

Class VersionedPath

java.lang.Object

org.forgerock.api.models.VersionedPath

public final class VersionedPath
extends Object

Class that represents versioned Resources on an API descriptor path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VersionedPath.Builder	Builder to help construct the VersionedPath.

Field Summary

Fields

Modifier and Type	Field	Description
static final Version	UNVERSIONED	Version 0.0 represents null/empty, for when resource versions are not required by an API (e.g., OpenIDM).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Resource	get(Version version)	Gets the Resource for a given version.
protected Map<Version,Resource>	getPaths()	Gets a Map of versions to Resources.
Set<Version>	getVersions()	Returns all resource-versions on this path.
int	hashCode()
static VersionedPath.Builder	versionedPath()	Create a new Builder for VersionedPath.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

UNVERSIONED

public static final Version UNVERSIONED

Version 0.0 represents null/empty, for when resource versions are not required by an API (e.g., OpenIDM).

Method Details

getPaths

protected Map<Version,Resource> getPaths()

Gets a Map of versions to Resources. This method is currently only used for JSON serialization.

Returns:

Map of versions to Resources.

get

public Resource get(Version version)

Gets the Resource for a given version.

Parameters:

version - Resource version

Returns:

Resource or null if does-not-exist.

getVersions

public Set<Version> getVersions()

Returns all resource-versions on this path.

Returns:

All resource-versions.

versionedPath

public static VersionedPath.Builder versionedPath()

Create a new Builder for VersionedPath.

Returns:

Builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object