Package io.opentimeline.opentimelineio

Class SerializableObject

java.lang.Object

io.opentimeline.OTIOObject

io.opentimeline.opentimelineio.SerializableObject

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

SerializableObjectWithMetadata, UnknownSchema

public class SerializableObject
extends OTIOObject

Base object for things that can be [de]serialized to/from .otio files.

Field Summary

Fields inherited from class io.opentimeline.OTIOObject

nativeManager

Constructor Summary

Constructors

Constructor	Description
SerializableObject()

Method Summary

Modifier and Type	Method	Description
SerializableObject	clone(ErrorStatus errorStatus)	Create a deepcopy of the SerializableObject
int	currentRefCount()
AnyDictionary	dynamicFields()
boolean	equals(java.lang.Object obj)
static SerializableObject	fromJSONFile(java.lang.String fileName, ErrorStatus errorStatus)
static SerializableObject	fromJSONString(java.lang.String input, ErrorStatus errorStatus)
boolean	isEquivalentTo(SerializableObject serializableObject)	Returns true if the contents of self and other match.
boolean	isUnknownSchema()	In general, SerializableObject will have a known schema but UnknownSchema subclass will redefine this property to be True
java.lang.String	schemaName()
int	schemaVersion()
boolean	toJSONFile(java.lang.String fileName, ErrorStatus errorStatus)
boolean	toJSONFile(java.lang.String fileName, ErrorStatus errorStatus, int indent)
java.lang.String	toJSONString(ErrorStatus errorStatus)
java.lang.String	toJSONString(ErrorStatus errorStatus, int indent)
java.lang.String	toString()

Methods inherited from class io.opentimeline.OTIOObject

close, getNativeManager, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SerializableObject

public SerializableObject()

Method Details

toJSONFile

public boolean toJSONFile(java.lang.String fileName, ErrorStatus errorStatus)

toJSONFile

public boolean toJSONFile(java.lang.String fileName, ErrorStatus errorStatus, int indent)

toJSONString

public java.lang.String toJSONString(ErrorStatus errorStatus)

toJSONString

public java.lang.String toJSONString(ErrorStatus errorStatus, int indent)

fromJSONFile

public static SerializableObject fromJSONFile(java.lang.String fileName, ErrorStatus errorStatus)

fromJSONString

public static SerializableObject fromJSONString(java.lang.String input, ErrorStatus errorStatus)

isEquivalentTo

public boolean isEquivalentTo(SerializableObject serializableObject)

Returns true if the contents of self and other match.

Parameters:

serializableObject - other SerializableObject

Returns:

true if the contents of both match, otherwise false

clone

public SerializableObject clone(ErrorStatus errorStatus)

Create a deepcopy of the SerializableObject

Parameters:

errorStatus - errorStatus to report error while cloning

Returns:

a deepcopy of the object

dynamicFields

public AnyDictionary dynamicFields()

isUnknownSchema

public boolean isUnknownSchema()

In general, SerializableObject will have a known schema but UnknownSchema subclass will redefine this property to be True

Returns:

true if schema is unknown, otherwise false

schemaName

public java.lang.String schemaName()

schemaVersion

public int schemaVersion()

currentRefCount

public int currentRefCount()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object