de.weltraumschaf.commons.application

Class Version

java.lang.Object

de.weltraumschaf.commons.application.Version

public final class Version
extends Object

Reads the current version from a property file.

The property files only defines one property. Important is to switch resource filtering on in your POM for that properties file.

  version=1.0.0
 

This property file may be processed by a Maven filter to provide the version from the pom.xml:

  version=${pom.version}
 

If you save the file in src/main/resources/foo/bar/version.properties you can use the version this way:

 Version version = new Version("/foo/bar/version.properties");
 version.load()
 println(version.getVersion);
 

Since:

1.0.0

Author:

Sven Strittmatter <weltraumschaf@googlemail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Version.PropertyNames Available properties in the file.

Field Summary

Fields

Modifier and Type	Field and Description
private Properties	properties Properties.
private boolean	propertiesLoaded Indicates whether the properties are already loaded or not.
private String	propertyFileName Location of property file.

Constructor Summary

Constructors

Constructor and Description
Version(String propertyFileName) Private constructor for singleton.

Method Summary

Modifier and Type	Method and Description
String	getVersion() Get the version string.
void	load() Opens the properties file and loads it.
(package private) void	loadImpl() Encapsulates the file loading.
String	toString() Returns the version string.

Methods inherited from class java.lang.Object

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

Field Detail

propertyFileName

private final String propertyFileName

Location of property file.

propertiesLoaded

private boolean propertiesLoaded

Indicates whether the properties are already loaded or not.

properties

private final Properties properties

Properties.

Constructor Detail

Version

public Version(String propertyFileName)

Private constructor for singleton.

Parameters:

propertyFileName - Location of file, e.g. /de/weltraumschaf/commons/version.properties.

Method Detail

load

public void load()
          throws IOException

Opens the properties file and loads it. Only loads th property file once.

Throws:

IOException - On IO errors of the property file.

loadImpl

void loadImpl()
       throws IOException

Encapsulates the file loading.

Throws:

IOException - On IO errors of the property file.

getVersion

public String getVersion()

Get the version string.

Returns:

never null or empty

toString

public String toString()

Returns the version string.

Overrides:

toString in class Object

Returns:

never null or empty