com.google.cloud.tools.jib.image

Class ImageReference

java.lang.Object

com.google.cloud.tools.jib.image.ImageReference

public class ImageReference
extends java.lang.Object

Represents an image reference.

See Also:

https://github.com/docker/distribution/blob/master/reference/reference.go, https://docs.docker.com/engine/reference/commandline/tag/#extended-description

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRegistry()
java.lang.String	getRepository()
java.lang.String	getTag()
static boolean	isValidRegistry(java.lang.String registry)
static boolean	isValidRepository(java.lang.String repository)
static boolean	isValidTag(java.lang.String tag)
static ImageReference	of(java.lang.String registry, java.lang.String repository, java.lang.String tag)
static ImageReference	parse(java.lang.String reference)
java.lang.String	toString()
java.lang.String	toStringWithTag()
boolean	usesDefaultTag()

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static ImageReference parse(java.lang.String reference)
                            throws InvalidImageReferenceException

Parameters:

reference - the string to parse

Returns:

an ImageReference parsed from the string

Throws:

InvalidImageReferenceException - if reference is formatted incorrectly

of

public static ImageReference of(@Nullable
                                java.lang.String registry,
                                java.lang.String repository,
                                @Nullable
                                java.lang.String tag)

Parameters:

registry - the image registry

repository - the image repository

tag - the image tag

Returns:

an ImageReference built from the given registry, repository, and tag

isValidRegistry

public static boolean isValidRegistry(java.lang.String registry)

Parameters:

registry - the registry to check

Returns:

true if is a valid registry; false otherwise

isValidRepository

public static boolean isValidRepository(java.lang.String repository)

Parameters:

repository - the repository to check

Returns:

true if is a valid repository; false otherwise

isValidTag

public static boolean isValidTag(java.lang.String tag)

Parameters:

tag - the tag to check

Returns:

true if is a valid tag; false otherwise

getRegistry

public java.lang.String getRegistry()

getRepository

public java.lang.String getRepository()

getTag

public java.lang.String getTag()

usesDefaultTag

public boolean usesDefaultTag()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the image reference in Docker-readable format (inverse of parse(java.lang.String))

toStringWithTag

public java.lang.String toStringWithTag()

Returns:

the image reference in Docker-readable format, without hiding the tag.