com.edorasware.commons.core.content.internal

Class ContentUtils

java.lang.Object

com.edorasware.commons.core.content.internal.ContentUtils

public class ContentUtils
extends Object

Utility class for content based operations.

Field Summary

Fields

Modifier and Type	Field and Description
static Type	CONTENT_INFO_PROPERTIES_TYPE_TOKEN The Type used for the de-/serialization of the ContentInfo.getProperties() map.

Method Summary

Modifier and Type	Method and Description
static void	deleteRecursively(Path directory) Deletes the given path (mostly a directory) recursively.
static <T> T	deserialize(String json, Type type) Deserialize the given JSON string to the respective object.
static ContentMetadata	deserializeContentMetadata(String jsonContentMetadata) Deserialize the given JSON string to a ContentMetadata.
static ContentReference	deserializeContentReference(String jsonContentReference) Deserialize the given JSON string to a ContentReference.
static void	lockAndProcessFile(Path fileToLock, com.google.common.base.Function<byte[],Optional<byte[]>> processingFunction) Opens the specified Path with create, sync, read and write mode (see StandardOpenOptions), tries to fully lock and then process it with the given function.
static String	serialize(Object object, Type type) Serialize the given ContentMetadata to a JSON string.
static String	serializeContentMetadata(ContentMetadata contentMetadata) Serialize the given ContentMetadata to a JSON string.
static String	serializeContentReference(ContentReference contentReference) Serialize the given ContentReference to a JSON string.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_INFO_PROPERTIES_TYPE_TOKEN

public static final Type CONTENT_INFO_PROPERTIES_TYPE_TOKEN

The Type used for the de-/serialization of the ContentInfo.getProperties() map.

Method Detail

deleteRecursively

public static void deleteRecursively(Path directory)

Deletes the given path (mostly a directory) recursively. This means that all files inside the directory will be deleted.

Parameters:

directory - the path to delete recursively

Throws:

ContentException - if there is an error while deleting the path

serializeContentReference

public static String serializeContentReference(ContentReference contentReference)

Serialize the given ContentReference to a JSON string.

Parameters:

contentReference - the content reference to serialize

Returns:

the JSON representation of the given content reference

deserializeContentReference

public static ContentReference deserializeContentReference(String jsonContentReference)

Deserialize the given JSON string to a ContentReference. It will return an instance of ContentReference.

Parameters:

jsonContentReference - the JSON representation of a content reference

Returns:

the deserialized content reference

serializeContentMetadata

public static String serializeContentMetadata(ContentMetadata contentMetadata)

Serialize the given ContentMetadata to a JSON string.

Parameters:

contentMetadata - the content metadata to serialize

Returns:

the JSON representation of the given content metadata

deserializeContentMetadata

public static ContentMetadata deserializeContentMetadata(String jsonContentMetadata)

Deserialize the given JSON string to a ContentMetadata. It will return an instance of DefaultContentMetadata.

Parameters:

jsonContentMetadata - the JSON representation of a content metadata

Returns:

the deserialized content metadata

serialize

public static String serialize(Object object,
                               Type type)

Serialize the given ContentMetadata to a JSON string.

Parameters:

object - the object to serialize

type - the type of the object to serialize

Returns:

the JSON representation of the given content metadata

deserialize

public static <T> T deserialize(String json,
                                Type type)

Deserialize the given JSON string to the respective object.

Parameters:

json - the JSON representation of a content metadata

Returns:

the deserialized content metadata

lockAndProcessFile

public static void lockAndProcessFile(Path fileToLock,
                                      com.google.common.base.Function<byte[],Optional<byte[]>> processingFunction)

Opens the specified Path with create, sync, read and write mode (see StandardOpenOptions), tries to fully lock and then process it with the given function. When the processing inside the function is finished, its optional output will be written back to the file if present.

Parameters:

fileToLock - the path of the file to lock

processingFunction - the function to process the content of the file.

Throws:

ContentException - if there is an IO error

OverlappingFileLockException - if the file to lock is already locked by this JVM. See FileChannel.lock() for more information.