org.jfrog.build.extractor

Class ModuleExtractorUtils

java.lang.Object

org.jfrog.build.extractor.ModuleExtractorUtils

public class ModuleExtractorUtils
extends java.lang.Object

Utilities for serializing/deserializing Module info as json

Constructor Summary

Constructors

Constructor and Description
ModuleExtractorUtils()

Method Summary

Modifier and Type	Method and Description
static Module	jsonStringToModule(java.lang.String json) Given a serialized json module string, deserialize it into a Module object.
static java.lang.String	moduleToJsonString(Module module) Given a Module object, serialize it as a json string.
static Module	readModuleFromFile(java.io.File fromFile) Given a file, read its contents as a json string and deserialize it as a Module object.
static void	saveModuleToFile(Module module, java.io.File toFile) Given a Module object, serialize it to a json string and write it to the provided file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleExtractorUtils

public ModuleExtractorUtils()

Method Detail

moduleToJsonString

public static java.lang.String moduleToJsonString(Module module)
                                           throws java.io.IOException

Given a Module object, serialize it as a json string.

Parameters:

module - The module to serialize

Returns:

The json string representing the serialized module

Throws:

java.io.IOException

jsonStringToModule

public static Module jsonStringToModule(java.lang.String json)
                                 throws java.io.IOException

Given a serialized json module string, deserialize it into a Module object.

Parameters:

json - The serialized json module string

Returns:

A Module object deserialized from the provided string

Throws:

java.io.IOException

saveModuleToFile

public static void saveModuleToFile(Module module,
                                    java.io.File toFile)
                             throws java.io.IOException

Given a Module object, serialize it to a json string and write it to the provided file.

Parameters:

module - The module object

toFile - The file to write the serialized module to

Throws:

java.io.IOException

readModuleFromFile

public static Module readModuleFromFile(java.io.File fromFile)
                                 throws java.io.IOException

Given a file, read its contents as a json string and deserialize it as a Module object.

Parameters:

fromFile - The file containing a serialized json string

Returns:

The Module object deserialized from the content of the file

Throws:

java.io.IOException