Package land.oras

Class Manifest

java.lang.Object

land.oras.Descriptor

land.oras.Manifest

All Implemented Interfaces:

Describable

@NullUnmarked
public final class Manifest
extends Descriptor
implements Describable

Class for manifest

Field Summary

Fields inherited from class land.oras.Descriptor

annotations, artifactType, digest, json, mediaType, size

Method Summary

Modifier and Type	Method	Description
static Manifest	empty()	Return a copy of an empty manifest
boolean	equals(Object o)
static Manifest	fromJson(String json)	Create a manifest from a JSON string
static Manifest	fromPath(Path path)	Create a manifest from a path
@NonNull ArtifactType	getArtifactType()	Get the artifact type
String	getArtifactTypeAsString()	Get the artifact type as string for JSON serialization
Config	getConfig()	Get the config
ManifestDescriptor	getDescriptor()	Get the manifest descriptor for this describable
String	getDigest()	Get the digest
List<Layer>	getLayers()	Get the layers
int	getSchemaVersion()	Get the schema version
Subject	getSubject()	Get the subject
String	getTopLevelDigest()	Get the top-level digest (for JSON serialization)
int	hashCode()
String	toString()
Manifest	withAnnotations(Map<String,String> annotations)	Return a new manifest with the given annotations
Manifest	withArtifactType(ArtifactType artifactType)	Return a new manifest with the given artifact type
Manifest	withConfig(Config config)	Return a new manifest with the given config
Manifest	withDescriptor(ManifestDescriptor descriptor)	Return a new manifest with the given descriptor
protected Manifest	withJson(String json)	Return same instance but with original JSON
Manifest	withLayers(List<Layer> layers)	Return a new manifest with the given layers
Manifest	withSubject(Subject subject)	Return a new manifest with the given config

Methods inherited from class land.oras.Descriptor

getAnnotations, getAnnotationsForJson, getJson, getMediaType, getSize, of, of, of, toJson, toSubject

Methods inherited from class java.lang.Object

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

Method Details

getSchemaVersion

public int getSchemaVersion()

Get the schema version

Returns:

The schema version

getArtifactType

public @NonNull ArtifactType getArtifactType()

Description copied from class: Descriptor

Get the artifact type

Overrides:

getArtifactType in class Descriptor

Returns:

The artifact type

getArtifactTypeAsString

public String getArtifactTypeAsString()

Get the artifact type as string for JSON serialization

Returns:

The artifact type as string

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

getDigest

public String getDigest()

Description copied from class: Descriptor

Get the digest

Overrides:

getDigest in class Descriptor

Returns:

The digest

getTopLevelDigest

public String getTopLevelDigest()

Get the top-level digest (for JSON serialization)

Returns:

The top-level digest

getConfig

public Config getConfig()

Get the config

Returns:

The config

getSubject

public Subject getSubject()

Description copied from interface: Describable

Get the subject

Specified by:

getSubject in interface Describable

Returns:

The subject

getLayers

public List<Layer> getLayers()

Get the layers

Returns:

The layers

withArtifactType

public Manifest withArtifactType(ArtifactType artifactType)

Return a new manifest with the given artifact type

Parameters:

artifactType - The artifact type

Returns:

The manifest

withLayers

public Manifest withLayers(List<Layer> layers)

Return a new manifest with the given layers

Parameters:

layers - The layers

Returns:

The manifest

withConfig

public Manifest withConfig(Config config)

Return a new manifest with the given config

Parameters:

config - The config

Returns:

The manifest

withSubject

public Manifest withSubject(Subject subject)

Return a new manifest with the given config

Parameters:

subject - The subject

Returns:

The manifest

withAnnotations

public Manifest withAnnotations(Map<String,String> annotations)

Return a new manifest with the given annotations

Parameters:

annotations - The annotations

Returns:

The manifest

withDescriptor

public Manifest withDescriptor(ManifestDescriptor descriptor)

Return a new manifest with the given descriptor

Parameters:

descriptor - The descriptor

Returns:

The manifest

withJson

protected Manifest withJson(String json)

Return same instance but with original JSON

Overrides:

withJson in class Descriptor

Parameters:

json - The original JSON

Returns:

The index

fromJson

public static Manifest fromJson(String json)

Create a manifest from a JSON string

Parameters:

json - The JSON string

Returns:

The manifest

fromPath

public static Manifest fromPath(Path path)

Create a manifest from a path

Parameters:

path - The path

Returns:

The manifest

empty

public static Manifest empty()

Return a copy of an empty manifest

Returns:

The empty manifest

equals

public boolean equals(Object o)

Overrides:

equals in class Descriptor

hashCode

public int hashCode()

Overrides:

hashCode in class Descriptor

toString

public String toString()

Overrides:

toString in class Descriptor