Package land.oras

Class Index

java.lang.Object

land.oras.Descriptor

land.oras.Index

All Implemented Interfaces:

Describable

public final class Index
extends Descriptor
implements Describable

Index from an OCI layout

Field Summary

Fields inherited from class land.oras.Descriptor

annotations, artifactType, digest, json, mediaType, size

Method Summary

Modifier and Type	Method	Description
static Index	fromJson(String json)	Create an index from a JSON string
static Index	fromManifests(List<ManifestDescriptor> descriptors)	Create an index from a list of manifests
static Index	fromPath(Path path)	Create an index from a path
@Nullable Map<String,String>	getAnnotations()	Get the annotations
ManifestDescriptor	getDescriptor()	Get the manifest descriptor for this describable
List<ManifestDescriptor>	getManifests()	Get the list of manifests
int	getSchemaVersion()	Get the schema version
Subject	getSubject()	Get the subject
Index	withDescriptor(ManifestDescriptor descriptor)	Return a new index with the given descriptor
protected Index	withJson(String json)	Return same instance but with original JSON
Index	withNewManifests(ManifestDescriptor manifest)	Return a new index with new manifest added to index
Index	withSubject(Subject subject)	Return a new index with the given subject

Methods inherited from class land.oras.Descriptor

getArtifactType, getDigest, getJson, getMediaType, getSize, of, of, of, toJson, toSubject

Methods inherited from class java.lang.Object

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

Method Details

getSchemaVersion

public int getSchemaVersion()

Get the schema version

Returns:

The schema version

getManifests

public List<ManifestDescriptor> getManifests()

Get the list of manifests

Returns:

The list of manifests

withNewManifests

public Index withNewManifests(ManifestDescriptor manifest)

Return a new index with new manifest added to index

Parameters:

manifest - The manifest

Returns:

The index

getDescriptor

public ManifestDescriptor getDescriptor()

Description copied from interface: Describable

Get the manifest descriptor for this describable

Specified by:

getDescriptor in interface Describable

Returns:

The manifest descriptor

getAnnotations

public @Nullable Map<String,String> getAnnotations()

Get the annotations

Overrides:

getAnnotations in class Descriptor

Returns:

The annotations

withDescriptor

public Index withDescriptor(ManifestDescriptor descriptor)

Return a new index with the given descriptor

Parameters:

descriptor - The descriptor

Returns:

The manifest

withJson

protected Index withJson(String json)

Return same instance but with original JSON

Overrides:

withJson in class Descriptor

Parameters:

json - The original JSON

Returns:

The index

getSubject

public Subject getSubject()

Description copied from interface: Describable

Get the subject

Specified by:

getSubject in interface Describable

Returns:

The subject

withSubject

public Index withSubject(Subject subject)

Return a new index with the given subject

Parameters:

subject - The subject

Returns:

The index

fromJson

public static Index fromJson(String json)

Create an index from a JSON string

Parameters:

json - The JSON string

Returns:

The index

fromPath

public static Index fromPath(Path path)

Create an index from a path

Parameters:

path - The path

Returns:

The index

fromManifests

public static Index fromManifests(List<ManifestDescriptor> descriptors)

Create an index from a list of manifests

Parameters:

descriptors - The list of manifests

Returns:

The index