Apache HttpCore 4.4.16 · org.apache.http.util.VersionInfo

Modifier and Type	Field and Description
private final String	infoClassloader The classloader from which the version info was obtained.
private final String	infoModule The module from the version info.
private final String	infoPackage The package that contains the version information.
private final String	infoRelease The release from the version info.
private final String	infoTimestamp The timestamp from the version info.
public static final String	PROPERTY_MODULE
public static final String	PROPERTY_RELEASE
public static final String	PROPERTY_TIMESTAMP
public static final String	UNAVAILABLE A string constant for unavailable information.
public static final String	VERSION_PROPERTY_FILE The filename of the version information files.

Access	Constructor and Description
protected	VersionInfo(final String the package pckg, final String the module, or `null` module, final String the release, or `null` release, final String the build time, or `null` time, final String the class loader, or `null` clsldr) Instantiates version information.

Method Summary

Modifier and Type	Method and Description
protected static VersionInfo	Returns: the version information fromMap(final String the package for the version information pckg, final Map<?, ?> the map from string keys to string values, for example `java.util.Properties` info, final ClassLoader the classloader, or `null` clsldr) Instantiates version information from properties.
public final String	Returns: the classloader description, never `null` getClassloader() Obtains the classloader used to read the version information.
public final String	Returns: the module name, never `null` getModule() Obtains the name of the versioned module or informal unit.
public final String	Returns: the package name, never `null` getPackage() Obtains the package name.
public final String	Returns: the release version, never `null` getRelease() Obtains the release of the versioned module or informal unit.
public final String	Returns: the timestamp, never `null` getTimestamp() Obtains the timestamp of the versioned module or informal unit.
public static String	getUserAgent(final String the component name, like "Apache-HttpClient". name, final String the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot. pkg, final Class<?> the class' class loader to load from, or `null` for the thread context class loader cls) Sets the user agent to `"<name>/<release> (Java/<java.version>)"`.
public static VersionInfo[]	Returns: the version information for all packages found, never `null` loadVersionInfo(final String[] the packages for which to load version info pckgs, final ClassLoader the classloader to load from, or `null` for the thread context classloader clsldr) Loads version information for a list of packages.
public static VersionInfo	Returns: the version information for the argument package, or `null` if not available loadVersionInfo(final String the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot. pckg, final ClassLoader the classloader to load from, or `null` for the thread context classloader clsldr) Loads version information for a package.
public String	Returns: a string holding this version information toString() Overrides java.lang.Object.toString. Provides the version information in human-readable format.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

infoClassloader	back to summary
private final String infoClassloader The classloader from which the version info was obtained.

infoModule	back to summary
private final String infoModule The module from the version info.

infoPackage	back to summary
private final String infoPackage The package that contains the version information.

infoRelease	back to summary
private final String infoRelease The release from the version info.

infoTimestamp	back to summary
private final String infoTimestamp The timestamp from the version info.

PROPERTY_MODULE	back to summary
public static final String PROPERTY_MODULE

PROPERTY_RELEASE	back to summary
public static final String PROPERTY_RELEASE

PROPERTY_TIMESTAMP	back to summary
public static final String PROPERTY_TIMESTAMP

UNAVAILABLE	back to summary
public static final String UNAVAILABLE A string constant for unavailable information.

VERSION_PROPERTY_FILE	back to summary
public static final String VERSION_PROPERTY_FILE The filename of the version information files.

Constructor Detail

VersionInfo back to summary

VersionInfo	back to summary
protected VersionInfo(final String pckg, final String module, final String release, final String time, final String clsldr) Instantiates version information. Parameters pckg:String the package module:String the module, or `null` release:String the release, or `null` time:String the build time, or `null` clsldr:String the class loader, or `null`

protected VersionInfo(final String pckg, final String module, final String release, final String time, final String clsldr)

Instantiates version information.

Parameters

pckg:String: the package
module:String: the module, or null
release:String: the release, or null
time:String: the build time, or null
clsldr:String: the class loader, or null

Method Detail

fromMap back to summary

fromMap	back to summary
protected static VersionInfo fromMap(final String pckg, final Map<?, ?> info, final ClassLoader clsldr) Instantiates version information from properties. Parameters pckg:String the package for the version information info:Map<?, ?> the map from string keys to string values, for example `java.util.Properties` clsldr:ClassLoader the classloader, or `null` Returns:VersionInfo the version information

protected static VersionInfo fromMap(final String pckg, final Map<?, ?> info, final ClassLoader clsldr)

Instantiates version information from properties.

Parameters

pckg:String: the package for the version information
info:Map<?, ?>: the map from string keys to string values, for example java.util.Properties
clsldr:ClassLoader: the classloader, or null

Returns:VersionInfo

the version information

getClassloader back to summary

getClassloader	back to summary
public final String getClassloader() Obtains the classloader used to read the version information. This is just the `toString` output of the classloader, since the version information should not keep a reference to the classloader itself. That could prevent garbage collection. Returns:String the classloader description, never `null`

public final String getClassloader()

Obtains the classloader used to read the version information. This is just the toString output of the classloader, since the version information should not keep a reference to the classloader itself. That could prevent garbage collection.

Returns:String: the classloader description, never null

getModule back to summary

getModule	back to summary
public final String getModule() Obtains the name of the versioned module or informal unit. This data is read from the version information for the package. Returns:String the module name, never `null`

public final String getModule()

Obtains the name of the versioned module or informal unit. This data is read from the version information for the package.

Returns:String: the module name, never null

getPackage back to summary

getPackage	back to summary
public final String getPackage() Obtains the package name. The package name identifies the module or informal unit. Returns:String the package name, never `null`

public final String getPackage()

Obtains the package name. The package name identifies the module or informal unit.

Returns:String: the package name, never null

getRelease back to summary

getRelease	back to summary
public final String getRelease() Obtains the release of the versioned module or informal unit. This data is read from the version information for the package. Returns:String the release version, never `null`

public final String getRelease()

Obtains the release of the versioned module or informal unit. This data is read from the version information for the package.

Returns:String: the release version, never null

getTimestamp back to summary

getTimestamp	back to summary
public final String getTimestamp() Obtains the timestamp of the versioned module or informal unit. This data is read from the version information for the package. Returns:String the timestamp, never `null`

public final String getTimestamp()

Obtains the timestamp of the versioned module or informal unit. This data is read from the version information for the package.

Returns:String: the timestamp, never null

getUserAgent back to summary

getUserAgent	back to summary
public static String getUserAgent(final String name, final String pkg, final Class<?> cls) Sets the user agent to `"<name>/<release> (Java/<java.version>)"`. For example: "Apache-HttpClient/4.3 (Java/1.6.0_35)" Parameters name:String the component name, like "Apache-HttpClient". pkg:String the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot. cls:Class<?> the class' class loader to load from, or `null` for the thread context class loader Since 4.3

public static String getUserAgent(final String name, final String pkg, final Class<?> cls)

Sets the user agent to "<name>/<release> (Java/<java.version>)".

For example:

"Apache-HttpClient/4.3 (Java/1.6.0_35)"

Parameters

name:String: the component name, like "Apache-HttpClient".
pkg:String: the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot.
cls:Class<?>: the class' class loader to load from, or null for the thread context class loader

Since

4.3

loadVersionInfo back to summary

loadVersionInfo	back to summary
public static VersionInfo[] loadVersionInfo(final String[] pckgs, final ClassLoader clsldr) Loads version information for a list of packages. Parameters pckgs:String[] the packages for which to load version info clsldr:ClassLoader the classloader to load from, or `null` for the thread context classloader Returns:VersionInfo[] the version information for all packages found, never `null`

public static VersionInfo[] loadVersionInfo(final String[] pckgs, final ClassLoader clsldr)

Loads version information for a list of packages.

Parameters

pckgs:String[]: the packages for which to load version info
clsldr:ClassLoader: the classloader to load from, or null for the thread context classloader

Returns:VersionInfo[]

the version information for all packages found, never null

loadVersionInfo back to summary

loadVersionInfo	back to summary
public static VersionInfo loadVersionInfo(final String pckg, final ClassLoader clsldr) Loads version information for a package. Parameters pckg:String the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot. clsldr:ClassLoader the classloader to load from, or `null` for the thread context classloader Returns:VersionInfo the version information for the argument package, or `null` if not available

public static VersionInfo loadVersionInfo(final String pckg, final ClassLoader clsldr)

Loads version information for a package.

Parameters

pckg:String: the package for which to load version information, for example "org.apache.http". The package name should NOT end with a dot.
clsldr:ClassLoader: the classloader to load from, or null for the thread context classloader

Returns:VersionInfo

the version information for the argument package, or null if not available

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Provides the version information in human-readable format. Returns:String a string holding this version information Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Provides the version information in human-readable format.

Returns:String

a string holding this version information

Annotations

@Override

public Class VersionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail