oshi.json.json

Interface OshiJsonObject

All Superinterfaces:

Serializable

All Known Subinterfaces:

Baseboard, CentralProcessor, ComputerSystem, Display, FileSystem, Firmware, GlobalMemory, HardwareAbstractionLayer, NetworkParams, OperatingSystem, OperatingSystemVersion, PowerSource, Sensors, UsbDevice

All Known Implementing Classes:

AbstractOshiJsonObject, BaseboardImpl, CentralProcessorImpl, ComputerSystemImpl, DisplayImpl, FileSystemImpl, FirmwareImpl, GlobalMemoryImpl, HardwareAbstractionLayerImpl, HWDiskStore, HWPartition, NetworkIF, NetworkParamsImpl, OperatingSystemImpl, OperatingSystemVersionImpl, OSFileStore, OSProcess, PowerSourceImpl, SensorsImpl, SystemInfo, UsbDeviceImpl

public interface OshiJsonObject
extends Serializable

Public interface functionality for JSON strings

Method Summary

Modifier and Type	Method and Description
String	toCompactJSON() Creates a compact JSON string containing the information for this class.
String	toCompactJSON(Properties properties) Creates a compact JSON string containing the information for this class.
javax.json.JsonObject	toJSON() Returns this object as a JsonObject.
javax.json.JsonObject	toJSON(Properties properties) Returns this object as a JsonObject.
String	toPrettyJSON() Creates a pretty JSON string containing the information for this class.
String	toPrettyJSON(Properties properties) Creates a pretty JSON string containing the information for this class.

Method Detail

toCompactJSON

String toCompactJSON()

Creates a compact JSON string containing the information for this class. The properties set by toCompactJSON(Properties) configure the type of information returned.

Returns:

a compact JSON string

toCompactJSON

String toCompactJSON(Properties properties)

Creates a compact JSON string containing the information for this class. The provided properties will be set on this object to configure the type of information returned using this and future invocations of toCompactJSON().

Parameters:

properties - Properties to configure returned results

Returns:

a compact JSON string

toPrettyJSON

String toPrettyJSON()

Creates a pretty JSON string containing the information for this class. The properties set by toPrettyJSON(Properties) configure the type of information returned.

Returns:

a pretty JSON string

toPrettyJSON

String toPrettyJSON(Properties properties)

Creates a pretty JSON string containing the information for this class. The provided properties will be set on this object to configure the type of information returned using this and future invocations of toPrettyJSON().

Parameters:

properties - Properties to configure returned results

Returns:

a pretty JSON string

toJSON

javax.json.JsonObject toJSON()

Returns this object as a JsonObject. The properties set by toJSON(Properties) configure the type of information returned.

Returns:

a JsonObject for this class.

toJSON

javax.json.JsonObject toJSON(Properties properties)

Returns this object as a JsonObject. The provided properties will be set on this object to configure the type of information returned using this and future invocations of toJSON().

Parameters:

properties - Properties to configure returned results

Returns:

a JsonObject for this class.