com.highqsoft.helper

Class ChangeLog

java.lang.Object

com.highqsoft.helper.ChangeLog

public class ChangeLog
extends java.lang.Object

This is the helper for change log files.

Since:

$Date: 2017/04/28 12:28:53 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHOR
protected static java.util.HashMap<java.lang.String,java.lang.String>	AUTHOR_MAP
static java.lang.String	DATE
static java.lang.String	ENTRY
static java.lang.String	MESSAGE_PREFIX
static java.lang.String	NAME
static java.lang.String	REVISION
static java.lang.String	TEXT
static java.lang.String	TIME

Constructor Summary

Constructors

Constructor and Description
ChangeLog()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String[]	getForClass(java.lang.Class clazz, boolean withName) Read the change log for one single class.
static java.lang.String	getVersion(java.lang.String revision) Read the version string from a revision string.
static void	main(java.lang.String[] args)
static java.lang.String[]	readFromStream(java.io.InputStream is, java.lang.String namePattern, boolean withName) Read stream array from changelog xml input stream.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_PREFIX

public static final java.lang.String MESSAGE_PREFIX

See Also:

Constant Field Values

ENTRY

public static final java.lang.String ENTRY

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

See Also:

Constant Field Values

TIME

public static final java.lang.String TIME

See Also:

Constant Field Values

AUTHOR

public static final java.lang.String AUTHOR

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

AUTHOR_MAP

protected static java.util.HashMap<java.lang.String,java.lang.String> AUTHOR_MAP

Constructor Detail

ChangeLog

public ChangeLog()

Method Detail

readFromStream

public static java.lang.String[] readFromStream(java.io.InputStream is,
                                java.lang.String namePattern,
                                boolean withName)
                                         throws org.xml.sax.SAXException,
                                                javax.xml.parsers.ParserConfigurationException,
                                                java.io.IOException

Read stream array from changelog xml input stream.

Parameters:

is - the stream

namePattern - include only these entries that matche this name pattern

withName - if true the output will include the name.

Returns:

a string array containing the log.

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

getForClass

public static java.lang.String[] getForClass(java.lang.Class clazz,
                             boolean withName)

Read the change log for one single class. The mehtod assums that there is a xml file called like the class that holds the changelog.

Parameters:

clazz - the class

withName - if true the return value contains the file.

Returns:

the change log

getVersion

public static java.lang.String getVersion(java.lang.String revision)

Read the version string from a revision string.

Parameters:

revision - the revision (e.g.: $Revision: 1.10 $)

Returns:

the version (e.g. 1.6)

main

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