org.apache.chemistry.opencmis.client.util

Class TypeUtils

java.lang.Object

org.apache.chemistry.opencmis.client.util.TypeUtils

public final class TypeUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeUtils.ValidationError

Method Summary

Modifier and Type	Method and Description
static boolean	checkQueryName(String queryName) Checks if a property query name is valid.
static TypeDefinition	readFromJSON(InputStream stream) Reads a type definition from a JSON stream.
static TypeDefinition	readFromXML(InputStream stream) Reads a type definition from a XML stream.
static List<TypeUtils.ValidationError>	validatePropertyDefinition(PropertyDefinition<?> propDef) Validates a property definition.
static List<TypeUtils.ValidationError>	validateTypeDefinition(TypeDefinition type) Validates a type definition.
static void	writeToJSON(TypeDefinition type, OutputStream stream) Serializes the type definition to JSON, using the format defined in the CMIS specification.
static void	writeToXML(TypeDefinition type, OutputStream stream) Serializes the type definition to XML, using the format defined in the CMIS specification.

Methods inherited from class java.lang.Object

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

Method Detail

writeToXML

public static void writeToXML(TypeDefinition type,
                              OutputStream stream)
                       throws XMLStreamException

Serializes the type definition to XML, using the format defined in the CMIS specification. The XML is UTF-8 encoded and the stream is not closed.

Throws:

XMLStreamException

writeToJSON

public static void writeToJSON(TypeDefinition type,
                               OutputStream stream)
                        throws IOException

Serializes the type definition to JSON, using the format defined in the CMIS specification. The JSON is UTF-8 encoded and the stream is not closed.

Throws:

IOException

readFromXML

public static TypeDefinition readFromXML(InputStream stream)
                                  throws XMLStreamException

Reads a type definition from a XML stream. The stream must be UTF-8 encoded.

Throws:

XMLStreamException

readFromJSON

public static TypeDefinition readFromJSON(InputStream stream)
                                   throws IOException,
                                          org.apache.chemistry.opencmis.commons.impl.json.parser.JSONParseException

Reads a type definition from a JSON stream. The stream must be UTF-8 encoded.

Throws:

IOException

org.apache.chemistry.opencmis.commons.impl.json.parser.JSONParseException

checkQueryName

public static boolean checkQueryName(String queryName)

Checks if a property query name is valid.

Parameters:

queryName - the query name

Returns:

true if the query name is valid, false otherwise

validateTypeDefinition

public static List<TypeUtils.ValidationError> validateTypeDefinition(TypeDefinition type)

Validates a type definition.

Returns:

the list of validation errors

validatePropertyDefinition

public static List<TypeUtils.ValidationError> validatePropertyDefinition(PropertyDefinition<?> propDef)

Validates a property definition.

Returns:

the list of validation errors