org.rvpf.base.util

Class Version

Object

Version

Direct Known Subclasses:

BaseVersion, ForwarderVersion, HTTPVersion, ProcessorVersion, ServiceVersion, StoreVersion, ToolsVersion

@Immutable
public abstract class Version
extends Object

Abstract version.

Subclasses provide the implementation version specified in the manifest of the jar from which they were loaded.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_NAME_ATTRIBUTE Application name attribute.
static String	BUNDLE_VERSION_ATTRIBUTE Bundle version attribute.
static String	IMPLEMENTATION_REVISION_ATTRIBUTE Implementation revision attribute.
static String	PROBLEM_INDICATOR Problem indicator.
static String	SPECIFICATION_VERSION_ATTRIBUTE Specification version attribute.
static String	UNKNOWN_INDICATOR Unknown indicator.

Constructor Summary

Constructors

Constructor and Description
Version()

Method Summary

Modifier and Type	Method and Description
Optional<DateTime>	getContainerDateTime() Gets the date-time of the container of this class.
static Optional<DateTime>	getContainerDateTime(String resourcePath) Gets the date-time of the container of a resource.
Optional<File>	getContainerFile() Gets the file of the container of this class.
static Optional<File>	getContainerFile(String resourcePath) Gets the file of the container of a resource.
String	getImplementationRevision() Gets the implementation revision text.
String	getImplementationTitle() Gets the implementation title.
String	getImplementationVendor() Gets the implementation vendor text.
String	getImplementationVersion() Gets the implementation version text.
static Manifest	getManifest(Class<?> objectClass) Gets the manifest from the jar containing an object class.
static String	getManifestAttribute(Manifest manifest, String attributeName) Gets an attribute from a jar manifest.
String	getSpecificationTitle() Gets the specification title.
String	getSpecificationVendor() Gets the specification vendor text.
String	getSpecificationVersion() Gets the specification version text.
void	logImplementation(boolean quiet) Logs the implementation.
void	logSpecification(boolean quiet) Logs the specification ident.
void	logSystemInfo(String identification) Logs system informations.
void	logSystemInfo(String identification, boolean quiet) Logs system informations.

Methods inherited from class Object

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

Field Detail

APPLICATION_NAME_ATTRIBUTE

public static final String APPLICATION_NAME_ATTRIBUTE

Application name attribute.

See Also:

Constant Field Values

BUNDLE_VERSION_ATTRIBUTE

public static final String BUNDLE_VERSION_ATTRIBUTE

Bundle version attribute.

See Also:

Constant Field Values

IMPLEMENTATION_REVISION_ATTRIBUTE

public static final String IMPLEMENTATION_REVISION_ATTRIBUTE

Implementation revision attribute.

See Also:

Constant Field Values

PROBLEM_INDICATOR

public static final String PROBLEM_INDICATOR

Problem indicator.

See Also:

Constant Field Values

SPECIFICATION_VERSION_ATTRIBUTE

public static final String SPECIFICATION_VERSION_ATTRIBUTE

Specification version attribute.

See Also:

Constant Field Values

UNKNOWN_INDICATOR

public static final String UNKNOWN_INDICATOR

Unknown indicator.

See Also:

Constant Field Values

Constructor Detail

Version

public Version()

Method Detail

getContainerDateTime

@Nonnull
 @CheckReturnValue
public static Optional<DateTime> getContainerDateTime(@Nonnull
                                                                                    String resourcePath)

Gets the date-time of the container of a resource.

Parameters:

resourcePath - The resource path.

Returns:

The optional date-time.

getContainerFile

@Nonnull
 @CheckReturnValue
public static Optional<File> getContainerFile(@Nonnull
                                                                            String resourcePath)

Gets the file of the container of a resource.

Parameters:

resourcePath - The resource path.

Returns:

The optional file (empty if path protocol is not 'file').

getManifest

@Nonnull
 @CheckReturnValue
public static Manifest getManifest(@Nonnull
                                                                 Class<?> objectClass)

Gets the manifest from the jar containing an object class.

Parameters:

objectClass - The object class.

Returns:

The manifest (empty on failure).

getManifestAttribute

@Nonnull
 @CheckReturnValue
public static String getManifestAttribute(@Nonnull
                                                                        Manifest manifest,
                                                                        @Nonnull
                                                                        String attributeName)

Gets an attribute from a jar manifest.

Parameters:

manifest - The manifest.

attributeName - The attribute name.

Returns:

The attribute value (PROBLEM_INDICATOR when missing).

getContainerDateTime

@Nonnull
 @CheckReturnValue
public final Optional<DateTime> getContainerDateTime()

Gets the date-time of the container of this class.

Returns:

The optional date-time.

getContainerFile

@Nonnull
 @CheckReturnValue
public final Optional<File> getContainerFile()

Gets the file of the container of this class.

Returns:

The optional file (empty if resource path protocol is not 'file').

getImplementationRevision

@Nonnull
 @CheckReturnValue
public final String getImplementationRevision()

Gets the implementation revision text.

Returns:

The version text or "*" if unavailable.

getImplementationTitle

@Nonnull
 @CheckReturnValue
public final String getImplementationTitle()

Gets the implementation title.

Returns:

The implementation title or "*" if unavailable.

getImplementationVendor

@Nonnull
 @CheckReturnValue
public final String getImplementationVendor()

Gets the implementation vendor text.

Returns:

The vendor text or "*" if unavailable.

getImplementationVersion

@Nonnull
 @CheckReturnValue
public final String getImplementationVersion()

Gets the implementation version text.

Returns:

The version text or "*" if unavailable.

getSpecificationTitle

@Nonnull
 @CheckReturnValue
public final String getSpecificationTitle()

Gets the specification title.

Returns:

The specification title or "*" if unavailable.

getSpecificationVendor

@Nonnull
 @CheckReturnValue
public final String getSpecificationVendor()

Gets the specification vendor text.

Returns:

The specification text or "*" if unavailable.

getSpecificationVersion

@Nonnull
 @CheckReturnValue
public final String getSpecificationVersion()

Gets the specification version text.

Returns:

The version text or "*" if unavailable.

logImplementation

public void logImplementation(boolean quiet)

Logs the implementation.

Parameters:

quiet - True for quiet logging (DEBUG instead of INFO).

logSpecification

public void logSpecification(boolean quiet)

Logs the specification ident.

Parameters:

quiet - True for quiet logging (DEBUG instead of INFO).

logSystemInfo

public void logSystemInfo(@Nonnull
                          String identification)

Logs system informations.

Parameters:

identification - The caller's identification.

logSystemInfo

public void logSystemInfo(@Nonnull
                          String identification,
                          boolean quiet)

Logs system informations.

Parameters:

identification - The caller's identification.

quiet - True for quiet logging (DEBUG instead of INFO).