org.jomc.util

Class VersionParser

java.lang.Object

org.jomc.util.VersionParser

All Implemented Interfaces:

VersionParserConstants

public final class VersionParser
extends Object
implements VersionParserConstants

Parses and compares version identifiers.

 Version    ::= Token ( ( <SEPARATOR> )* Token )* <EOF>
 Token      ::= <INTEGER>
              | <IDENTIFIER>
 

A separator character is defined as

 [".","_","-","@","/","\\"," ","\t","\n","\r","\f","\b","\"","\'"]

An integer is a sequence of digits. An identifier is everything else, not a separator character or an integer.

Version:

$JOMC: VersionParser.jj 5091 2016-04-04 15:40:17Z schulte $

Author:

Christian Schulte

See Also:

compare(String, String)

Field Summary

Fields

Modifier and Type	Field and Description
Token	jj_nt Next token.
Token	token Current token.
VersionParserTokenManager	token_source Generated Token Manager.

Fields inherited from interface org.jomc.util.VersionParserConstants

DEFAULT, EOF, IDENTIFIER, INTEGER, SEPARATOR, tokenImage

Constructor Summary

Constructors

Constructor and Description
VersionParser(InputStream stream) Constructor with InputStream.
VersionParser(InputStream stream, String encoding) Constructor with InputStream and supplied encoding
VersionParser(Reader stream) Constructor.
VersionParser(VersionParserTokenManager tm) Constructor with generated Token Manager.

Method Summary

Methods

Modifier and Type	Method and Description
static int	compare(String v1, String v2) Compares two versions for order.
void	disable_tracing() Disable tracing.
void	enable_tracing() Enable tracing.
ParseException	generateParseException() Generate ParseException.
Token	getNextToken() Get the next Token.
Token	getToken(int index) Get the specific Token.
Token[]	parse() Parses the input to produce an array of tokens.
void	ReInit(InputStream stream) Reinitialise.
void	ReInit(InputStream stream, String encoding) Reinitialise.
void	ReInit(Reader stream) Reinitialise.
void	ReInit(VersionParserTokenManager tm) Reinitialise.

Methods inherited from class java.lang.Object

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

Field Detail

token_source

public VersionParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Detail

VersionParser

public VersionParser(InputStream stream)

Constructor with InputStream.

VersionParser

public VersionParser(InputStream stream,
             String encoding)

Constructor with InputStream and supplied encoding

VersionParser

public VersionParser(Reader stream)

Constructor.

VersionParser

public VersionParser(VersionParserTokenManager tm)

Constructor with generated Token Manager.

Method Detail

parse

public Token[] parse()
              throws ParseException,
                     TokenMgrError

Parses the input to produce an array of tokens.

Returns:

The parsed tokens.

Throws:

ParseException - if the parse fails.

TokenMgrError - for any invalid tokens.

compare

public static int compare(String v1,
          String v2)
                   throws ParseException,
                          TokenMgrError

Compares two versions for order.

This method parses the given strings to produce a sequence of tokens and then compares these tokens for order.

Parameters:

v1 - The version to compare with.

v2 - The version to compare to.

Returns:

A negative integer, zero, or a positive integer as the first version is less than, equal to, or greater than the second.

Throws:

NullPointerException - if v1 or v2 is null.

ParseException - if parsing fails.

TokenMgrError - for any invalid tokens.

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
          String encoding)

Reinitialise.

ReInit

public void ReInit(Reader stream)

Reinitialise.

ReInit

public void ReInit(VersionParserTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.