SmartObject (Crater Dog Java Smart Objects 3.13 API)

java.lang.Object
- craterdog.smart.SmartObject<S>

Type Parameters:

S - The concrete type of the smart object.

All Implemented Interfaces:

craterdog.core.Composite, Comparable<S>
```
public abstract class SmartObject<S extends SmartObject<S>>
extends Object
implements Comparable<S>, craterdog.core.Composite
```
This abstract class provides implementations for the standard methods defined in the Object class. It also adds a generics based copy() method that is superior to the clone() method in many ways.

Author:

Derk Norton, Jeff Webb, Mukesh Jyothi, Yan Ma

Constructor Summary

Constructors
Constructor and Description

SmartObject()

Constructors
Constructor and Description
`SmartObject()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addSerializableClass(Class<?> serializable)` This protected method allows a subclass to add to the mappers a class type that can be serialized using its toString().
`protected void`	`addSerializableClass(Class<?> serializable, Class<?> mixin)` This protected method allows a subclass to add to the mappers a class type that can be serialized using mixin class.
`protected void`	`addSerializableClass(com.fasterxml.jackson.databind.Module module)` This protected method allows a subclass to add to the mappers a Jackson module that can be used to serialize and deserialize instances of the subclass.
`int`	`compareTo(S object)`
`<T extends SmartObject<S>> T`	`copy()` This method should work for all objects.
`static com.fasterxml.jackson.databind.ObjectMapper`	`createMapper(com.fasterxml.jackson.databind.Module... modules)` This function generates a new object mapper with the specified modules.
`boolean`	`equals(Object object)` This method determines whether or not two objects are equal.
`static <T> T`	`fromString(Class<T> classType, String json)` This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object.
`static <T> T`	`fromString(com.fasterxml.jackson.core.type.TypeReference<T> classType, String json)` This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object.
`int`	`hashCode()` This method returns a hash code for the object based on its string form.
`protected String`	`toExposedString()` This method behaves similarly to the `toString()` method except that it does not perform any censorship of sensitive attributes.
`String`	`toString()` This method returns a string containing a structured, human readable version of the object.
`static String`	`toString(Object object)` This function generates a Javascript Object Notation (JSON) string from an object.
`static String`	`toString(Object object, String indentation)` This function generates an indented Javascript Object Notation (JSON) string from an object.
`String`	`toString(String indentation)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SmartObject
```
public SmartObject()
```
- Method Detail
  - toString
```
public String toString()
```
    This method returns a string containing a structured, human readable version of the object. The string is formatted in Javascript Object Notation (JSON).
    
    Specified by:
    
    toString in interface craterdog.core.Composite
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The formatted JSON string.
  - toString
```
public String toString(String indentation)
```
    Specified by:
    
    toString in interface craterdog.core.Composite
  - toExposedString
```
protected String toExposedString()
```
    This method behaves similarly to the toString() method except that it does not perform any censorship of sensitive attributes. It should only be used when the resulting output will not be stored or seen by anyone.
    
    Returns:
    
    The formatted JSON string.
  - equals
```
public boolean equals(Object object)
```
    This method determines whether or not two objects are equal. Two objects are equal if they have the same class type and all their attributes and sub-components are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The object to be compared with this object.
    
    Returns:
    
    Whether or not the two objects are equal.
  - compareTo
```
public int compareTo(S object)
```
    Specified by:
    
    compareTo in interface Comparable<S extends SmartObject<S>>
  - copy
```
public <T extends SmartObject<S>> T copy()
```
    This method should work for all objects. However, it is very inefficient and should only be used sparingly and for unit testing.
    
    Type Parameters:
    
    T - The concrete type of the smart object.
    
    Returns:
    
    An exact copy of the smart object.
  - hashCode
```
public int hashCode()
```
    This method returns a hash code for the object based on its string form. This is not a very efficient method.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash code for the object.
  - fromString
```
public static <T> T fromString(Class<T> classType,
                               String json)
                        throws IOException
```
    This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object. This function can be used for any non-parameterized type for example:
```
     Customer customer = SmartObject.fromString(Customer.class, jsonString);
 
```
    Type Parameters:
    
    T - The type of object being constructed.
    
    Parameters:
    
    classType - The concrete class type being constructed.
    
    json - The JSON string.
    
    Returns:
    
    The corresponding object.
    
    Throws:
    
    IOException - The JSON string could not be parsed correctly.
  - fromString
```
public static <T> T fromString(com.fasterxml.jackson.core.type.TypeReference<T> classType,
                               String json)
                        throws IOException
```
    This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object. This function can be used for any parameterized type for example:
```
     List<String> list = SmartObject.fromString(new TypeReference<List<String>>() { }, jsonString);
 
```
    The anonymous type declaration is required due to Java's erasure of parameterized types at runtime.
    Type Parameters:
    
    T - The type of object being constructed.
    
    Parameters:
    
    classType - The parameterized class type being constructed.
    
    json - The JSON string.
    
    Returns:
    
    The corresponding object.
    
    Throws:
    
    IOException - The JSON string could not be parsed correctly.
  - toString
```
public static String toString(Object object)
```
    This function generates a Javascript Object Notation (JSON) string from an object.
    
    Parameters:
    
    object - The object to be turned into a JSON string.
    
    Returns:
    
    The corresponding JSON string.
  - toString
```
public static String toString(Object object,
                              String indentation)
```
    This function generates an indented Javascript Object Notation (JSON) string from an object.
    
    Parameters:
    
    object - The object to be turned into a JSON string.
    
    indentation - The amount of space that should be prepended to each line.
    
    Returns:
    
    The corresponding JSON string.
  - createMapper
```
public static com.fasterxml.jackson.databind.ObjectMapper createMapper(com.fasterxml.jackson.databind.Module... modules)
```
    This function generates a new object mapper with the specified modules. For example, to create object mapper that masks sensitive attributes do the following:
```
 ObjectMapper mapper = SmartObject.createMapper(new CensorshipModule());
 
```
    Parameters:
    
    modules - The list of modules that should be added to the object mapper.
    
    Returns:
    
    A new object mapper containing the specified modules.
  - addSerializableClass
```
protected void addSerializableClass(Class<?> serializable)
```
    This protected method allows a subclass to add to the mappers a class type that can be serialized using its toString().
    
    Parameters:
    
    serializable - The type of class that can be serialized using its toString() method.
  - addSerializableClass
```
protected void addSerializableClass(Class<?> serializable,
                                    Class<?> mixin)
```
    This protected method allows a subclass to add to the mappers a class type that can be serialized using mixin class.
    
    Parameters:
    
    serializable - The type of class that can be serialized using its toString() method.
    
    mixin - The type of class that can be used to serialized the serializable class.
  - addSerializableClass
```
protected void addSerializableClass(com.fasterxml.jackson.databind.Module module)
```
    This protected method allows a subclass to add to the mappers a Jackson module that can be used to serialize and deserialize instances of the subclass.
    
    Parameters:
    
    module - The type of class that can be serialized using its toString() method.

Class SmartObject<S extends SmartObject<S>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SmartObject

Method Detail

toString

toString

toExposedString

equals

compareTo

copy

hashCode

fromString

fromString

toString

toString

createMapper

addSerializableClass

addSerializableClass

addSerializableClass