de.cketti.library.changelog

Class ChangeLog

java.lang.Object

de.cketti.library.changelog.ChangeLog

public class ChangeLog
extends Object

Display a dialog showing a full or partial (What's New) change log.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ChangeLog.ChangeLogTag Contains constants for the root element of changelog.xml.
protected static interface	ChangeLog.ChangeTag Contains constants for the change element of changelog.xml.
static class	ChangeLog.ReleaseItem Container used to store information about a release/version.
protected static interface	ChangeLog.ReleaseTag Contains constants for the release element of changelog.xml.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CSS Default CSS styles used to format the change log.
protected static String	LOG_TAG Tag that is used when sending error/debug messages to the log.
protected Context	mContext Context that is used to access the resources and to create the ChangeLog dialogs.
protected String	mCss Contains the CSS rules used to format the change log.
protected static int	NO_VERSION Constant that used when no version code is available.
protected static String	VERSION_KEY This is the key used when storing the version code in SharedPreferences.

Constructor Summary

Constructors

Constructor and Description
ChangeLog(Context context) Create a ChangeLog instance using the default SharedPreferences file.
ChangeLog(Context context, SharedPreferences preferences, String css) Create a ChangeLog instance using the supplied SharedPreferences instance.
ChangeLog(Context context, String css) Create a ChangeLog instance using the default SharedPreferences file.

Method Summary

Methods

Modifier and Type	Method and Description
List<ChangeLog.ReleaseItem>	getChangeLog(boolean full) Returns the merged change log.
protected Comparator<ChangeLog.ReleaseItem>	getChangeLogComparator() Returns a Comparator that specifies the sort order of the ChangeLog.ReleaseItems.
int	getCurrentVersionCode() Get version code of current installation.
String	getCurrentVersionName() Get version name of current installation.
protected AlertDialog	getDialog(boolean full) Create a dialog containing (parts of the) change log.
String	getFullLog() Get full change log as HTML string.
AlertDialog	getFullLogDialog() Get a dialog with the full change log.
int	getLastVersionCode() Get version code of last installation.
protected SparseArray<ChangeLog.ReleaseItem>	getLocalizedChangeLog(boolean full) Read localized change log from xml[-lang]/changelog.xml
String	getLog() Get changes since last version as HTML string.
protected String	getLog(boolean full) Get (partial) change log as HTML string.
AlertDialog	getLogDialog() Get the "What's New" dialog.
protected SparseArray<ChangeLog.ReleaseItem>	getMasterChangeLog(boolean full) Read master change log from xml/changelog_master.xml
boolean	isFirstRun() Check if this is the first execution of this app version.
boolean	isFirstRunEver() Check if this is a new installation.
protected SparseArray<ChangeLog.ReleaseItem>	readChangeLog(XmlPullParser xml, boolean full) Read the change log from an XML file.
protected SparseArray<ChangeLog.ReleaseItem>	readChangeLogFromResource(int resId, boolean full) Read change log from XML resource file.
void	skipLogDialog() Skip the "What's new" dialog for this app version.
protected void	updateVersionInPreferences() Write current version code to the preferences.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final String LOG_TAG

Tag that is used when sending error/debug messages to the log.

See Also:

Constant Field Values

VERSION_KEY

protected static final String VERSION_KEY

This is the key used when storing the version code in SharedPreferences.

See Also:

Constant Field Values

NO_VERSION

protected static final int NO_VERSION

Constant that used when no version code is available.

See Also:

Constant Field Values

DEFAULT_CSS

public static final String DEFAULT_CSS

Default CSS styles used to format the change log.

See Also:

Constant Field Values

mContext

protected final Context mContext

Context that is used to access the resources and to create the ChangeLog dialogs.

mCss

protected final String mCss

Contains the CSS rules used to format the change log.

Constructor Detail

ChangeLog

public ChangeLog(Context context)

Create a ChangeLog instance using the default SharedPreferences file.

Parameters:

context - Context that is used to access the resources and to create the ChangeLog dialogs.

ChangeLog

public ChangeLog(Context context,
         String css)

Create a ChangeLog instance using the default SharedPreferences file.

Parameters:

context - Context that is used to access the resources and to create the ChangeLog dialogs.

css - CSS styles that will be used to format the change log.

ChangeLog

public ChangeLog(Context context,
         SharedPreferences preferences,
         String css)

Create a ChangeLog instance using the supplied SharedPreferences instance.

Parameters:

context - Context that is used to access the resources and to create the ChangeLog dialogs.

preferences - SharedPreferences instance that is used to persist the last version code.

css - CSS styles used to format the change log (excluding <style> and </style>).

Method Detail

getLastVersionCode

public int getLastVersionCode()

Get version code of last installation.

Returns:

The version code of the last installation of this app (as described in the former manifest). This will be the same as returned by getCurrentVersionCode() the second time this version of the app is launched (more precisely: the second time ChangeLog is instantiated).

See Also:

android:versionCode

getCurrentVersionCode

public int getCurrentVersionCode()

Get version code of current installation.

Returns:

The version code of this app as described in the manifest.

See Also:

android:versionCode

getCurrentVersionName

public String getCurrentVersionName()

Get version name of current installation.

Returns:

The version name of this app as described in the manifest.

See Also:

android:versionName

isFirstRun

public boolean isFirstRun()

Check if this is the first execution of this app version.

Returns:

true if this version of your app is started the first time.

isFirstRunEver

public boolean isFirstRunEver()

Check if this is a new installation.

Returns:

true if your app including ChangeLog is started the first time ever. Also true if your app was uninstalled and installed again.

skipLogDialog

public void skipLogDialog()

Skip the "What's new" dialog for this app version.

Future calls to isFirstRun() and isFirstRunEver() will return false for the current app version.

getLogDialog

public AlertDialog getLogDialog()

Get the "What's New" dialog.

Returns:

An AlertDialog displaying the changes since the previous installed version of your app (What's New). But when this is the first run of your app including ChangeLog then the full log dialog is show.

getFullLogDialog

public AlertDialog getFullLogDialog()

Get a dialog with the full change log.

Returns:

An AlertDialog with a full change log displayed.

getDialog

protected AlertDialog getDialog(boolean full)

Create a dialog containing (parts of the) change log.

Parameters:

full - If this is true the full change log is displayed. Otherwise only changes for versions newer than the last version are displayed.

Returns:

A dialog containing the (partial) change log.

updateVersionInPreferences

protected void updateVersionInPreferences()

Write current version code to the preferences.

getLog

public String getLog()

Get changes since last version as HTML string.

Returns:

HTML string containing the changes since the previous installed version of your app (What's New).

getFullLog

public String getFullLog()

Get full change log as HTML string.

Returns:

HTML string containing the full change log.

getLog

protected String getLog(boolean full)

Get (partial) change log as HTML string.

Parameters:

full - If this is true the full change log is returned. Otherwise only changes for versions newer than the last version are returned.

Returns:

The (partial) change log.

getChangeLog

public List<ChangeLog.ReleaseItem> getChangeLog(boolean full)

Returns the merged change log.

Parameters:

full - If this is true the full change log is returned. Otherwise only changes for versions newer than the last version are returned.

Returns:

A sorted List containing ChangeLog.ReleaseItems representing the (partial) change log.

See Also:

getChangeLogComparator()

getMasterChangeLog

protected SparseArray<ChangeLog.ReleaseItem> getMasterChangeLog(boolean full)

Read master change log from xml/changelog_master.xml

See Also:

readChangeLogFromResource(int, boolean)

getLocalizedChangeLog

protected SparseArray<ChangeLog.ReleaseItem> getLocalizedChangeLog(boolean full)

Read localized change log from xml[-lang]/changelog.xml

See Also:

readChangeLogFromResource(int, boolean)

readChangeLogFromResource

protected final SparseArray<ChangeLog.ReleaseItem> readChangeLogFromResource(int resId,
                                                           boolean full)

Read change log from XML resource file.

Parameters:

resId - Resource ID of the XML file to read the change log from.

full - If this is true the full change log is returned. Otherwise only changes for versions newer than the last version are returned.

Returns:

A SparseArray containing ChangeLog.ReleaseItems representing the (partial) change log.

readChangeLog

protected SparseArray<ChangeLog.ReleaseItem> readChangeLog(XmlPullParser xml,
                                               boolean full)

Read the change log from an XML file.

Parameters:

xml - The XmlPullParser instance used to read the change log.

full - If true the full change log is read. Otherwise only the changes since the last (saved) version are read.

Returns:

A SparseArray mapping the version codes to release information.

getChangeLogComparator

protected Comparator<ChangeLog.ReleaseItem> getChangeLogComparator()

Returns a Comparator that specifies the sort order of the ChangeLog.ReleaseItems.

The default implementation returns the items in reverse order (latest version first).