Index (Crater Dog Java Smart Objects 3.18 API)

A

addSerializableClass(Module) - Method in class craterdog.smart.SmartObject: 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.
addSerializableClass(Class<?>) - Method in class craterdog.smart.SmartObject: This protected method allows a subclass to add to the mappers a class type that can be serialized using its toString().
addSerializableClass(Class<?>, Class<?>) - Method in class craterdog.smart.SmartObject: This protected method allows a subclass to add to the mappers a class type that can be serialized using mixin class.

Censor - Class in craterdog.smart: This class performs the masking function on a specified string value using a specified mask.
Censor() - Constructor for class craterdog.smart.Censor: This constructor creates a new Censor object that uses the default 'X' character for masking.
Censor(char) - Constructor for class craterdog.smart.Censor: This constructor creates a new Censor object that uses the specified character for masking.
CensorshipModule - Class in craterdog.smart: This class is a Jackson module that can be added to an object mapper to handle the masking of sensitive attributes during string serialization.
CensorshipModule() - Constructor for class craterdog.smart.CensorshipModule: The default constructor adds a censorship serializer that has no mask defined.
character() - Element in annotation interface craterdog.smart.Sensitive: The character that should be used to mask the value of the annotated attribute.
compareTo(S) - Method in class craterdog.smart.SmartObject
copy() - Method in class craterdog.smart.SmartObject: This method should work for all objects.
craterdog.smart - package craterdog.smart
createMapper(Module...) - Static method in class craterdog.smart.SmartObject: This function generates a new object mapper with the specified modules.

equals(Object) - Method in class craterdog.smart.SmartObject: This method determines whether or not two objects are equal.

fromString(TypeReference<T>, String) - Static method in class craterdog.smart.SmartObject: This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object.
fromString(Class<T>, String) - Static method in class craterdog.smart.SmartObject: This function takes string containing Javascript Object Notation (JSON) and uses it to construct the corresponding smart object.

hashCode() - Method in class craterdog.smart.SmartObject: This method returns a hash code for the object based on its string form.

mask() - Element in annotation interface craterdog.smart.Sensitive: The masking pattern that should be applied to the value of the annotated attribute.
MASK_CREDIT_CARD_NUMBER - Static variable in annotation interface craterdog.smart.Sensitive: Mask for a credit card number: dddd-XXXX-XXXX-dddd
MASK_EMAIL_ADDRESS - Static variable in annotation interface craterdog.smart.Sensitive: Mask for a email address.
MASK_PASSWORD - Static variable in annotation interface craterdog.smart.Sensitive: Mask for a password or alphanumeric pin with various lengths (min length = 4, max length = 100): mask all characters
MASK_PHONE_NUMBER - Static variable in annotation interface craterdog.smart.Sensitive: Mask for a phone number: XXX-XXX-dddd leave the last four digits unmasked
MASK_SSN - Static variable in annotation interface craterdog.smart.Sensitive: MASK for a SSN: XXX-XX-dddd leave the last four digits unmasked

process(String, String) - Method in class craterdog.smart.Censor: This method masks the given string according to the groups specified in the specified mask.

Sensitive - Annotation Interface in craterdog.smart: This annotation is used to mark string attributes that contain sensitive information and should be masked when output to a log file, and encrypted when stored in a database.
SmartObject<S extends SmartObject<S>> - Class in craterdog.smart: This abstract class provides implementations for the standard methods defined in the Object class.
SmartObject() - Constructor for class craterdog.smart.SmartObject

toDouble() - Method in interface craterdog.smart.UseToDoubleAsValueMixIn: This method returns a double version of the object.
toExposedString() - Method in class craterdog.smart.SmartObject: This method behaves similarly to the toString() method except that it does not perform any censorship of sensitive attributes.
toInteger() - Method in interface craterdog.smart.UseToIntegerAsValueMixIn: This method returns an integer version of the object.
toString() - Method in class craterdog.smart.SmartObject: This method returns a string containing a structured, human readable version of the object.
toString() - Method in interface craterdog.smart.UseToStringAsValueMixIn: This method returns a string version of the object.
toString(Object) - Static method in class craterdog.smart.SmartObject: This function generates a Javascript Object Notation (JSON) string from an object.
toString(Object, String) - Static method in class craterdog.smart.SmartObject: This function generates an indented Javascript Object Notation (JSON) string from an object.
toString(String) - Method in class craterdog.smart.SmartObject
type() - Element in annotation interface craterdog.smart.Sensitive: The type of sensitive attribute.

UseToDoubleAsValueMixIn - Interface in craterdog.smart: This mixin interface tells the Jackson parser to use the toDouble() method to generate the value of an attribute.
UseToIntegerAsValueMixIn - Interface in craterdog.smart: This mixin interface tells the Jackson parser to use the toInteger() method to generate the value of an attribute.
UseToStringAsValueMixIn - Interface in craterdog.smart: This mixin interface tells the Jackson parser to use the toString() method to generate the value of an attribute.