com.helger.xml.util.changelog

Class ChangeLogSerializer

java.lang.Object

com.helger.xml.util.changelog.ChangeLogSerializer

@Immutable
public final class ChangeLogSerializer
extends Object

This class handles the reading and writing of changelog objects.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog>	readAllChangeLogs()
static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog>	readAllChangeLogs(ClassLoader aClassLoader)
static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog>	readAllChangeLogs(IChangeLogSerializerCallback aErrorCallback)
static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog>	readAllChangeLogs(IChangeLogSerializerCallback aErrorCallback, ClassLoader aClassLoader)
static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog>	readAllChangeLogs(com.helger.commons.lang.IHasClassLoader aClassLoaderProvider)
static com.helger.commons.changelog.ChangeLog	readChangeLog(com.helger.commons.io.IHasInputStream aISP) Read the change log resource specified by the input stream provider using the default logging callback.
static com.helger.commons.changelog.ChangeLog	readChangeLog(com.helger.commons.io.IHasInputStream aISP, IChangeLogSerializerCallback aErrorCallback) Read the change log resource specified by the input stream provider.
static IMicroDocument	writeChangeLog(com.helger.commons.changelog.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 com.helger.commons.changelog.ChangeLog readChangeLog(@Nullable
                                                                              com.helger.commons.io.IHasInputStream 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 com.helger.commons.changelog.ChangeLog readChangeLog(@Nullable
                                                                              com.helger.commons.io.IHasInputStream aISP,
                                                                              @Nonnull
                                                                              IChangeLogSerializerCallback 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 com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog> readAllChangeLogs()

readAllChangeLogs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog> readAllChangeLogs(@Nullable
                                                                                                                                                           ClassLoader aClassLoader)

readAllChangeLogs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog> readAllChangeLogs(@Nonnull
                                                                                                                                                           com.helger.commons.lang.IHasClassLoader aClassLoaderProvider)

readAllChangeLogs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog> readAllChangeLogs(@Nonnull
                                                                                                                                                           IChangeLogSerializerCallback aErrorCallback)

readAllChangeLogs

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsMap<URI,com.helger.commons.changelog.ChangeLog> readAllChangeLogs(@Nonnull
                                                                                                                                                           IChangeLogSerializerCallback aErrorCallback,
                                                                                                                                                           @Nullable
                                                                                                                                                           ClassLoader aClassLoader)

writeChangeLog

@Nonnull
public static IMicroDocument writeChangeLog(@Nonnull
                                                      com.helger.commons.changelog.ChangeLog aChangeLog)