com.phloc.commons.changelog

Class ChangeLogSerializer

java.lang.Object

com.phloc.commons.changelog.ChangeLogSerializer

@Immutable
public final class ChangeLogSerializer
extends Object

This class handles the reading and writing of changelog objects.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static Map<URI,ChangeLog>	readAllChangeLogs()
static Map<URI,ChangeLog>	readAllChangeLogs(ClassLoader aClassLoader)
static Map<URI,ChangeLog>	readAllChangeLogs(INonThrowingRunnableWithParameter<String> aErrorCallback)
static Map<URI,ChangeLog>	readAllChangeLogs(INonThrowingRunnableWithParameter<String> aErrorCallback, ClassLoader aClassLoader)
static ChangeLog	readChangeLog(IInputStreamProvider aISP) Read the change log resource specified by the input stream provider using the default logging callback.
static ChangeLog	readChangeLog(IInputStreamProvider aISP, INonThrowingRunnableWithParameter<String> aErrorCallback) Read the change log resource specified by the input stream provider.
static IMicroDocument	writeChangeLog(ChangeLog aChangeLog)

Methods inherited from class java.lang.Object

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

Method Detail

readChangeLog

@Nullable
public static ChangeLog readChangeLog(@Nullable
                               IInputStreamProvider aISP)

Read the change log resource specified by the input stream provider using the default logging callback.

Parameters:

aISP - The ISP to read from. Maybe null resulting in a null return.

Returns:

null if the passed ISP was null.

readChangeLog

@Nullable
public static ChangeLog readChangeLog(@Nullable
                               IInputStreamProvider aISP,
                               @Nonnull
                               INonThrowingRunnableWithParameter<String> aErrorCallback)

Read the change log resource specified by the input stream provider.

Parameters:

aISP - The ISP to read from. Maybe null resulting in a null return.

aErrorCallback - The callback that handles potential errors.

Returns:

null if the passed ISP was null.

readAllChangeLogs

@Nonnull
@ReturnsMutableCopy
public static Map<URI,ChangeLog> readAllChangeLogs()

readAllChangeLogs

@Nonnull
@ReturnsMutableCopy
public static Map<URI,ChangeLog> readAllChangeLogs(@Nonnull
                                                              ClassLoader aClassLoader)

readAllChangeLogs

@Nonnull
@ReturnsMutableCopy
public static Map<URI,ChangeLog> readAllChangeLogs(@Nonnull
                                                              INonThrowingRunnableWithParameter<String> aErrorCallback)

readAllChangeLogs

@Nonnull
@ReturnsMutableCopy
public static Map<URI,ChangeLog> readAllChangeLogs(@Nonnull
                                                              INonThrowingRunnableWithParameter<String> aErrorCallback,
                                                              @Nonnull
                                                              ClassLoader aClassLoader)

writeChangeLog

@Nonnull
public static IMicroDocument writeChangeLog(@Nonnull
                                    ChangeLog aChangeLog)