Package land.oras

Class Descriptor

java.lang.Object

land.oras.Descriptor

Direct Known Subclasses:

Config, Index, Layer, Manifest

public sealed class Descriptor
extends Object
permits Config, Manifest, Layer, Index

Main class for descriptor

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable Map<String,String>	annotations	Annotations for the layer
protected final @Nullable String	artifactType	The artifact type
protected final @Nullable String	digest	The digest of the layer
protected String	json	Original json
protected final String	mediaType	The media type of the layer
protected @Nullable String	registry	The registry
protected final @Nullable Long	size	The size of the layer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Descriptor(String digest, Long size, String mediaType, Map<String,String> annotations, String artifactType, String registry, String json)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getAnnotations()	Get the annotations
@Nullable Map<String,String>	getAnnotationsForJson()	We never serialize empty annotations
@Nullable ArtifactType	getArtifactType()	Get the artifact type
@Nullable String	getDigest()	Get the digest
String	getJson()	Return the original JSON
final String	getMediaType()	Get the media type
@Nullable String	getRegistry()	Return the resolved registry.
@Nullable Long	getSize()	Get the size
int	hashCode()
static Descriptor	of(String digest, Long size)	Create a new descriptor
static Descriptor	of(String digest, Long size, String mediaType)	Create a new descriptor
static Descriptor	of(String digest, Long size, String mediaType, Map<String,String> annotations, String artifactType)	Create a new descriptor
final String	toJson()	Return the JSON representation of this descriptor
String	toString()
Subject	toSubject()	Return this manifest descriptor as a subject
protected Descriptor	withJson(String json)	Return same instance but with original JSON
protected Descriptor	withRegistry(String registry)	Return same instance but with resolved registry

Methods inherited from class java.lang.Object

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

Field Details

mediaType

protected final String mediaType

The media type of the layer

annotations

protected final @Nullable Map<String,String> annotations

Annotations for the layer

digest

protected final @Nullable String digest

The digest of the layer

size

protected final @Nullable Long size

The size of the layer

artifactType

protected final @Nullable String artifactType

The artifact type

json

protected String json

Original json

registry

protected @Nullable String registry

The registry

Constructor Details

Descriptor

protected Descriptor(String digest,
 Long size,
 String mediaType,
 Map<String,String> annotations,
 String artifactType,
 String registry,
 String json)

Constructor

Parameters:

digest - The digest

size - The size

mediaType - The media type

annotations - The annotations

artifactType - The artifact type

json - The original JSON

Method Details

getJson

public String getJson()

Return the original JSON

Returns:

The original JSON

getRegistry

public @Nullable String getRegistry()

Return the resolved registry. Useful to avoid querying registry blobs when the registry is already resolved in the descriptor.

Returns:

The resolved registry or null if not resolved

getAnnotations

public Map<String,String> getAnnotations()

Get the annotations

Returns:

The annotations

getAnnotationsForJson

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

We never serialize empty annotations

Returns:

The annotations or null

getMediaType

public final String getMediaType()

Get the media type

Returns:

The media type

getDigest

public @Nullable String getDigest()

Get the digest

Returns:

The digest

getSize

public @Nullable Long getSize()

Get the size

Returns:

The size

getArtifactType

public @Nullable ArtifactType getArtifactType()

Get the artifact type

Returns:

The artifact type

toJson

public final String toJson()

Return the JSON representation of this descriptor

Returns:

The JSON string

withJson

protected Descriptor withJson(String json)

Return same instance but with original JSON

Parameters:

json - The original JSON

Returns:

The index

withRegistry

protected Descriptor withRegistry(String registry)

Return same instance but with resolved registry

Parameters:

registry - The resolved registry

Returns:

The descriptor with resolved registry

toSubject

public Subject toSubject()

Return this manifest descriptor as a subject

Returns:

The subject

of

public static Descriptor of(String digest,
 Long size,
 String mediaType,
 Map<String,String> annotations,
 String artifactType)

Create a new descriptor

Parameters:

digest - The digest

size - The size

mediaType - The media type

annotations - The annotations

artifactType - The artifact type

Returns:

The descriptor

of

public static Descriptor of(String digest,
 Long size,
 String mediaType)

Create a new descriptor

Parameters:

digest - The digest

size - The size

mediaType - The media type

Returns:

The descriptor

of

public static Descriptor of(String digest,
 Long size)

Create a new descriptor

Parameters:

digest - The digest

size - The size

Returns:

The descriptor

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object