com.exasol.containers.ExasolDockerImageReference Maven / Gradle / Ivy

Go to download
package com.exasol.containers;

/**
 * Reference to an Exasol Docker image.
 */
public interface ExasolDockerImageReference {
    /**
     * Get the major version of the {@code exasol/docker-db} image if possible.
     *
     * @return major version number of the docker image
     */
    public int getMajor();

    /**
     * Check if the major version available.
     *
     * @return {@code true} if the major version was detected.
     */
    public boolean hasMajor();

    /**
     * Get the minor version of the {@code exasol/docker-db} image if possible.
     *
     * @return minor version number of the docker image
     */
    public int getMinor();

    /**
     * Check if the minor version is available.
     *
     * @return {@code true} if the minor version was detected or complemented.
     */
    public boolean hasMinor();

    /**
     * Get the fix version of the {@code exasol/docker-db} image if possible.
     *
     * @return fix version number of the docker image
     */
    public int getFixVersion();

    /**
     * Check if the fix version is available.
     *
     * @return {@code true} if the fix version was detected or complemented.
     */
    public boolean hasFix();

    /**
     * Get the revision of the {@code exasol/docker-db} image if possible.
     *
     * @return revision of the docker image
     */
    public int getDockerImageRevision();

    /**
     * Check if the docker image revision is available.
     *
     * @return {@code true} if the docker image revision version was detected or complemented.
     */
    public boolean hasDockerImageRevision();

    /**
     * Get the version prefix of the {@code exasol/docker-db} image if possible.
     * 
     * Version prefixes are typically found in development versions like "prerelease".
     * 
     *
     * @return version suffix
     */
    public String getPrefix();

    /**
     * Check if a version prefix is available.
     *
     * @return {@code true} if a version prefix.
     */
    public boolean hasPrefix();
    /**
     * Get the version suffix of the {@code exasol/docker-db} image if possible.
     * 
     * Version suffixes are typically found in development versions like "alpha", "beta" or "RC1".
     * 
     *
     * @return version suffix
     */
    public String getSuffix();

    /**
     * Check if a version suffix is available.
     *
     * @return {@code true} if a version suffix.
     */
    public boolean hasSuffix();

    /**
     * Get the Docker image reference for an Exasol version number.
     *
     * @return Docker image Reference
     */
    @Override
    public String toString();

}