A C D E F G P R S T

A

addPduToDocument(Class<?>) - Method in class com.yepher.jsondoc.ClassListDriverBase

methods required in subclasses

addPduToDocument(Class<?>) - Method in interface com.yepher.jsondoc.DocumentorDriver

add a class to the list of classes that are referenced and should be documented

addToList(Class<?>) - Method in class com.yepher.jsondoc.Documentor

C

ClassListDriverBase - Class in com.yepher.jsondoc

ClassListDriverBase() - Constructor for class com.yepher.jsondoc.ClassListDriverBase

com.yepher.jsondoc - package com.yepher.jsondoc

com.yepher.jsondoc.helpers - package com.yepher.jsondoc.helpers

create(Gson, TypeToken<T>) - Method in class com.yepher.jsondoc.helpers.EnumeratedSubclassAdapterFactory

D

Documentor - Class in com.yepher.jsondoc

Documentor() - Constructor for class com.yepher.jsondoc.Documentor

DocumentorDriver - Interface in com.yepher.jsondoc

interface for callbacks from Documentor to its driver

documentPDU(Class<?>) - Method in class com.yepher.jsondoc.Documentor

E

emit(String) - Method in class com.yepher.jsondoc.ClassListDriverBase

methods from the DocumentorDriver interface

emit(String) - Method in interface com.yepher.jsondoc.DocumentorDriver

emitLine() - Method in class com.yepher.jsondoc.ClassListDriverBase

emitLine(String) - Method in class com.yepher.jsondoc.ClassListDriverBase

emitLine() - Method in interface com.yepher.jsondoc.DocumentorDriver

emitLine(String) - Method in interface com.yepher.jsondoc.DocumentorDriver

EnumeratedSubclassAdapterFactory - Class in com.yepher.jsondoc.helpers

a factory for GSON TypeAdapters for base classes with the EnumeratedSubclasses interface.

EnumeratedSubclassAdapterFactory() - Constructor for class com.yepher.jsondoc.helpers.EnumeratedSubclassAdapterFactory

EnumeratedSubclasses<E> - Interface in com.yepher.jsondoc.helpers

an interface that must be implemented by base classes to be used with EnumeratedSubclassAdapterFactory (which is used with GSON)

F

fromJson(String, TypeToken<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(String, Class<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(String, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(Reader, Class<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(Reader, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(JsonReader, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(JsonElement, Class<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

fromJson(JsonElement, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

G

generateFooter - Variable in class com.yepher.jsondoc.ClassListDriverBase

getAdapter(TypeToken<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

getAdapter(Class<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

getDelegateAdapter(TypeAdapterFactory, TypeToken<T>) - Method in class com.yepher.jsondoc.helpers.GsonHelper

getFooter() - Method in class com.yepher.jsondoc.ClassListDriverBase

getInstance() - Static method in class com.yepher.jsondoc.helpers.GsonHelper

get the GsonHelper singleton instance

getOutputPath() - Method in class com.yepher.jsondoc.ClassListDriverBase

getPdusToDocument() - Method in class com.yepher.jsondoc.ClassListDriverBase

getPdusToExclude() - Method in class com.yepher.jsondoc.ClassListDriverBase

getSubclass() - Method in interface com.yepher.jsondoc.helpers.EnumeratedSubclasses

get the enum value that identifies this subclass instance

getSubclass() - Method in interface com.yepher.jsondoc.helpers.SubclassEnumeration

get the class identified by the enumeration value

getTag() - Method in interface com.yepher.jsondoc.helpers.SubclassEnumeration

get the tag that will identify this sub-class in JSON

getTitle() - Method in class com.yepher.jsondoc.ClassListDriverBase

GsonHelper - Class in com.yepher.jsondoc.helpers

helper class for GSON that: includes support for enumerated subclasses; is a singleton that eliminates the need for repetitive constructions of the GSON instance

P

printToConsole(String) - Method in class com.yepher.jsondoc.ClassListDriverBase

printToConsole(String) - Method in interface com.yepher.jsondoc.DocumentorDriver

R

run(String[]) - Method in class com.yepher.jsondoc.ClassListDriverBase

S

setDriver(DocumentorDriver) - Method in class com.yepher.jsondoc.Documentor

set the documentor driver

setOutputPath(String) - Method in class com.yepher.jsondoc.ClassListDriverBase

setPrettyPrinting(boolean) - Method in class com.yepher.jsondoc.helpers.GsonHelper

staticMethodName - Static variable in interface com.yepher.jsondoc.helpers.EnumeratedSubclasses

the name of the static method that gets the enum values that identify the subclasses of the base class

SubclassEnumeration<T> - Interface in com.yepher.jsondoc.helpers

interface for enum's that identify subclasses for use with EnumeratedSubclassAdapterFactory (which is used with GSON)

T

toJson(Object) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(Object, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(Object, Appendable) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(Object, Type, Appendable) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(Object, Type, JsonWriter) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(JsonElement) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(JsonElement, Appendable) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJson(JsonElement, JsonWriter) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJsonTree(Object) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toJsonTree(Object, Type) - Method in class com.yepher.jsondoc.helpers.GsonHelper

toString() - Method in class com.yepher.jsondoc.helpers.GsonHelper

A C D E F G P R S T