freenet.node

Class Version

java.lang.Object

freenet.node.Version

public class Version
extends java.lang.Object

Central spot for stuff related to the versioning of the codebase. Note: when using the fields of this class, you must note that the Java compiler compiles constant final static fields into the class definitions of classes that use them. This might not be the most appropriate behaviour when, eg. creating a class that reports statistics. A final static field can be made "non-constant" in the eyes of the compiler by initialising it with the results of a method, eg T identity(T o) { T o; }; however the "constant" behaviour might be required in some cases. A more flexible solution is to add a method that returns the field, eg publicVersion(), and choose between the method and the field as necessary.

$ grep -R "\WVersion\.\w*[^(a-zA-Z]" src

can be used to find the places in the source code whose logic needs to be checked for this.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRevision Revision number of Version.java as read from CVS
static int	lastGoodStableBuild Oldest stable build of Fred we will talk to
static java.lang.String	nodeName FReenet Reference Daemon
static java.lang.String	nodeVersion The current tree version.
static java.lang.String	protocolVersion The protocol version supported
static java.lang.String	publicVersion The version for publicity purposes i.e.
static java.lang.String	stableNodeVersion The current stable tree version
static java.lang.String	stableProtocolVersion The stable protocol version supported

Constructor Summary

Constructors

Constructor and Description
Version()

Method Summary

Modifier and Type	Method and Description
static int	buildNumber() Use this method when you want the value returned to be the run-time version, not the build-time version.
static boolean	checkArbitraryGoodVersion(java.lang.String version, java.lang.String lastGoodVersion)
static boolean	checkGoodVersion(java.lang.String version)
static java.lang.String	cvsRevision() Analogous to buildNumber() but for cvsRevision.
static java.lang.String	explainBadVersion(java.lang.String version)
static int	getArbitraryBuildNumber(java.lang.String version)
static int	getArbitraryBuildNumber(java.lang.String version, int defaultValue)
static int	getHighestSeenBuild()
static java.lang.String[]	getLastGoodVersion()
static java.lang.String	getLastGoodVersionString()
static java.lang.String[]	getVersion()
static java.lang.String	getVersionString()
static int	lastGoodBuild()
static void	main(java.lang.String[] args)
static java.lang.String	publicVersion() Analogous to buildNumber() but for publicVersion.
static boolean	sameArbitraryVersion(java.lang.String[] v, java.lang.String[] lgv)
static boolean	sameVersion(java.lang.String[] v)
static void	seenVersion(java.lang.String version) Update static variable highestSeenBuild anytime we encounter a new node with a higher version than we've seen before
static long	transitionTime() Analogous to buildNumber() but for transitionTime.

Methods inherited from class java.lang.Object

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

Field Detail

nodeName

public static final java.lang.String nodeName

FReenet Reference Daemon

See Also:

Constant Field Values

nodeVersion

public static final java.lang.String nodeVersion

The current tree version. FIXME: This is part of the node compatibility computations, so cannot be safely changed!!! Hence publicVersion ...

See Also:

Constant Field Values

publicVersion

public static final java.lang.String publicVersion

The version for publicity purposes i.e. the version of the node that has been released.

See Also:

Constant Field Values

protocolVersion

public static final java.lang.String protocolVersion

The protocol version supported

See Also:

Constant Field Values

stableNodeVersion

public static final java.lang.String stableNodeVersion

The current stable tree version

See Also:

Constant Field Values

stableProtocolVersion

public static final java.lang.String stableProtocolVersion

The stable protocol version supported

See Also:

Constant Field Values

lastGoodStableBuild

public static final int lastGoodStableBuild

Oldest stable build of Fred we will talk to

See Also:

Constant Field Values

cvsRevision

public static final java.lang.String cvsRevision

Revision number of Version.java as read from CVS

See Also:

Constant Field Values

Constructor Detail

Version

public Version()

Method Detail

buildNumber

public static int buildNumber()

Use this method when you want the value returned to be the run-time version, not the build-time version. For example, if you compile your class, then modify this class and compile it (the build script does this automatically), but don't re-compile your original class, then that will still have the old version compiled into it, since it is a static constant.

Returns:

The build number (not SVN revision number) of this node.

publicVersion

public static java.lang.String publicVersion()

Analogous to buildNumber() but for publicVersion.

transitionTime

public static long transitionTime()

Analogous to buildNumber() but for transitionTime.

lastGoodBuild

public static int lastGoodBuild()

Returns:

The lowest build number with which the node will connect and exchange data normally.

cvsRevision

public static java.lang.String cvsRevision()

Analogous to buildNumber() but for cvsRevision.

getVersion

public static java.lang.String[] getVersion()

Returns:

the node's version designators as an array

getLastGoodVersion

public static java.lang.String[] getLastGoodVersion()

getVersionString

public static java.lang.String getVersionString()

Returns:

the version string that should be presented in the NodeReference

getLastGoodVersionString

public static java.lang.String getLastGoodVersionString()

Returns:

is needed for the freeviz

checkGoodVersion

public static boolean checkGoodVersion(java.lang.String version)

Returns:

true if requests should be accepted from nodes brandishing this version string

checkArbitraryGoodVersion

public static boolean checkArbitraryGoodVersion(java.lang.String version,
                                                java.lang.String lastGoodVersion)

Returns:

true if requests should be accepted from nodes brandishing this version string, given an arbitrary lastGoodVersion

explainBadVersion

public static java.lang.String explainBadVersion(java.lang.String version)

Returns:

string explaining why a version string is rejected

getArbitraryBuildNumber

public static int getArbitraryBuildNumber(java.lang.String version)
                                   throws VersionParseException

Returns:

the build number of an arbitrary version string

Throws:

VersionParseException

getArbitraryBuildNumber

public static int getArbitraryBuildNumber(java.lang.String version,
                                          int defaultValue)

seenVersion

public static void seenVersion(java.lang.String version)

Update static variable highestSeenBuild anytime we encounter a new node with a higher version than we've seen before

getHighestSeenBuild

public static int getHighestSeenBuild()

sameVersion

public static boolean sameVersion(java.lang.String[] v)

Returns:

true if the string describes the same node version as ours. Note that the build number may be different, and is ignored.

sameArbitraryVersion

public static boolean sameArbitraryVersion(java.lang.String[] v,
                                           java.lang.String[] lgv)

Returns:

true if the string describes the same node version as an arbitrary one. Note that the build number may be different, and is ignored.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Throwable

Throws:

java.lang.Throwable