com.getperka.flatpack.ext.package.json Maven / Gradle / Ivy
{
"com.getperka.flatpack.ext.TypeHint": "Indicates how certain simple {@link com.getperka.flatpack.ext.JsonKind JsonKind} types should be interpreted as more complex values.",
"com.getperka.flatpack.ext.TypeContext": "Provides access to typesystem information and vends helper objects.\n \n Instances of TypeContext are thread-safe and intended to be long-lived.",
"com.getperka.flatpack.ext.TypeContext:extractProperties(java.lang.Class)": "Examine a class and return {@link com.getperka.flatpack.ext.Property Property} helpers that describe all JSON properties that the\n type is expected to interact with. Calls to this method are cached in the instance of\n {@link com.getperka.flatpack.ext.TypeContext TypeContext}.",
"com.getperka.flatpack.ext.TypeContext:getClass(java.lang.String)": "Returns a Class from a payload name or null if the type is unknown.",
"com.getperka.flatpack.ext.TypeContext:getCodex(java.lang.Class)": "Convenience method to provide generics alignment.",
"com.getperka.flatpack.ext.TypeContext:getCodex(java.lang.reflect.Type)": "Return a Codex instance that can operate on the specified type.",
"com.getperka.flatpack.ext.TypeContext:getPayloadName(java.lang.Class)": "Returns the \"type\" name used for an entity type in the data section of the payload.",
"com.getperka.flatpack.ext.TypeContext:getPrincipalPaths(java.lang.Class)": "Returns zero or more property paths that can be evaluated to find an object that can be\n resolved to a user principal. The returned list will be ordered with the shortest paths first.",
"com.getperka.flatpack.ext.Type": "A simple JSON type description.",
"com.getperka.flatpack.ext.Type:toString()": "Returns a human-readable description of the type.",
"com.getperka.flatpack.ext.SerializationContext": "Holds all of the state necessary to perform a serialization.",
"com.getperka.flatpack.ext.SerializationContext:add(com.getperka.flatpack.HasUuid)": "Returns true if entity needs to be processed.",
"com.getperka.flatpack.ext.SerializationContext:getEntities()": "Returns the entities that should be included in the payload's data section, filtered by the\n cutoff time.",
"com.getperka.flatpack.ext.SerializationContext:getTraversalMode()": "Returns the {@link com.getperka.flatpack.TraversalMode TraversalMode} that should be used when scanning an entity.",
"com.getperka.flatpack.ext.SerializationContext:getWriter()": "Returns the JsonWriter accumulating JSON to be written.",
"com.getperka.flatpack.ext.PropertyPath": "Represents a sequence of simple property evaluations.",
"com.getperka.flatpack.ext.PropertyPath:evaluate(java.lang.Object, com.getperka.flatpack.ext.PropertyPath.Receiver)": "Evaluate each possible property value in the path, passing the value to receiver.",
"com.getperka.flatpack.ext.PropertyPath:getPath()": "Return an unmodifiable view of the properties that comprise the path.",
"com.getperka.flatpack.ext.PropertyPath:toString()": "For debugging use only.",
"com.getperka.flatpack.ext.PropertyPath.Receiver:receive(java.lang.Object)": "Returns true if additional values should be received.",
"com.getperka.flatpack.ext.Property": "An immutable view of a property that should be serialized.",
"com.getperka.flatpack.ext.Property:PROPERTY_NAME_COMPARATOR": "Sorts Property objects by {@link com.getperka.flatpack.ext.Property:getName() #getName()}.",
"com.getperka.flatpack.ext.Property:getEnclosingTypeName()": "The payload name of the type that defines the property.",
"com.getperka.flatpack.ext.Property:getGetter()": "Returns the getter method for this Property. The returned method will have a non-void\n return type and no parameters.",
"com.getperka.flatpack.ext.Property:getGetterRoleNames()": "Returns the role names that are allowed to get the property. A value containing a single\n asterisk means that all roles may access the property.",
"com.getperka.flatpack.ext.Property:getImpliedPropery()": "When a new value is assigned to the current property in some instance, the implied property of\n the new value should also be updated with the current instance.",
"com.getperka.flatpack.ext.Property:getName()": "Returns the json payload name of the Property, which may differ from the bean name if a\n {@link com.getperka.flatpack.JsonProperty JsonProperty} annotation has been applied to the getter.",
"com.getperka.flatpack.ext.Property:getSetter()": "Returns the optional setter for the property. The returned method will have a single parameter\n and a void return type.",
"com.getperka.flatpack.ext.Property:getSetterRoleNames()": "Return the role names that are allowed to set this property. A value containing a single\n asterisk means that all roles may set the property.",
"com.getperka.flatpack.ext.Property:getType()": "A simplified description of the property's type.",
"com.getperka.flatpack.ext.Property:isDeepTraversalOnly()": "Returns true if the Property should be included only during a deep traversal.",
"com.getperka.flatpack.ext.Property:isEmbedded()": "Returns true if an entity Property's properties should be emitted into the owning\n entity's properties.",
"com.getperka.flatpack.ext.Property:isInheritPrincipal()": "Returns true if the referred entity's owner should also be considered an owner of the\n entity that defines the Property.",
"com.getperka.flatpack.ext.Property:isSuppressDefaultValue()": "If true, non-null properties that contain the property type's default value will not be\n serialized. For example, integer properties whose values are 0 will not be serialized.",
"com.getperka.flatpack.ext.Property:mayGet(java.util.Collection)": "Returns true if a user with the given roles may retrieve the property. The roles\n provided must intersect or be assignable to the roles defined on the getter via\n {@link javax.annotation.security.RolesAllowed RolesAllowed}.",
"com.getperka.flatpack.ext.Property:maySet(java.util.Collection)": "Returns true if a user with the given roles may set the property. The roles provided\n must intersect or be assignable to the roles defined on the setter via {@link javax.annotation.security.RolesAllowed RolesAllowed}. If\n no roles were specified on the setter method, the roles defined on the getter will be used.",
"com.getperka.flatpack.ext.Property:toString()": "For debugging use only.",
"com.getperka.flatpack.ext.Property.Builder": "Constructs {@link com.getperka.flatpack.ext.Property Property} instances.",
"com.getperka.flatpack.ext.Property.Builder:from(com.getperka.flatpack.ext.Property)": "Copy initializer.",
"com.getperka.flatpack.ext.Property.Builder:peek()": "Returns the Property object under construction.",
"com.getperka.flatpack.ext.PrincipalMapper": "Provides Flatpack with a mapping from entities to identities that may edit the entities.",
"com.getperka.flatpack.ext.PrincipalMapper:getPrincipals(com.getperka.flatpack.HasUuid)": "Return all principals that are allowed to edit the entity or any entities that have a simple\n path reference to the object.",
"com.getperka.flatpack.ext.PrincipalMapper:getRoles(java.security.Principal)": "Returns all roles that the principal is allowed to act as.",
"com.getperka.flatpack.ext.PrincipalMapper:isAccessEnforced(java.security.Principal, com.getperka.flatpack.HasUuid)": "Allows entity access restrictions to be bypassed for super-users or specific entities.",
"com.getperka.flatpack.ext.PrincipalMapper:isMapped(java.util.List>, java.lang.Class)": "Returns true if {@link com.getperka.flatpack.ext.PrincipalMapper:getPrincipals(com.getperka.flatpack.HasUuid) #getPrincipals(HasUuid)} should be expected to return useful\n data for an instance of the given type.",
"com.getperka.flatpack.ext.PostWorkOrder": "Used to sort Callables passed into\n {@link com.getperka.flatpack.ext.BaseContext:addPostWork(java.util.concurrent.Callable) DeserializationContext#addPostWork(java.util.concurrent.Callable)}.",
"com.getperka.flatpack.ext.JsonKind": "Used to map individual properties to the kind of JSON element used to encode the property's\n value.",
"com.getperka.flatpack.ext.EntityResolver": "Allows existing entities to be injected into the reification process. The EntityResolver will be\n used when there is an unsatisfied reference to a UUID in the payload (i.e. there is no object in\n the data section with the requested UUID).",
"com.getperka.flatpack.ext.EntityResolver:resolve(java.lang.Class, java.util.UUID)": "Return an existing instance of the requested type with the given uuid or null",
"com.getperka.flatpack.ext.EntityResolver:resolve(java.lang.Class, java.util.UUID)[0]": "the type to be loaded",
"com.getperka.flatpack.ext.EntityResolver:resolve(java.lang.Class, java.util.UUID)[1]": "the UUID of the existing entity",
"com.getperka.flatpack.ext.DeserializationContext": "Contains state relating to in-process deserialization.",
"com.getperka.flatpack.ext.DeserializationContext:addModified(com.getperka.flatpack.HasUuid, com.getperka.flatpack.ext.Property)": "Record the modification of an entity's property.",
"com.getperka.flatpack.ext.DeserializationContext:checkAccess(com.getperka.flatpack.HasUuid)": "Apply a principal-based security check for entities that were resolved from the backing store.\n This code will follow one or more property paths for the entity and resolve the object at the\n end of the path into one or more principals. The test passes if the current principal is in the\n list. Otherwise, a warning is added to the context.",
"com.getperka.flatpack.ext.DeserializationContext:getEntity(java.util.UUID)": "Retrieve an entity previously provided to {@link com.getperka.flatpack.ext.DeserializationContext:putEntity(java.util.UUID, com.getperka.flatpack.HasUuid, boolean) #putEntity}.",
"com.getperka.flatpack.ext.DeserializationContext:getModifiedProperties(com.getperka.flatpack.HasUuid)": "Returns the Properties that were modified.",
"com.getperka.flatpack.ext.DeserializationContext:putEntity(java.util.UUID, com.getperka.flatpack.HasUuid, boolean)": "Stores an entity to be identified by a UUID. This method will call\n {@link com.getperka.flatpack.HasUuid:setUuid(java.util.UUID) HasUuid#setUuid(UUID)} on the provided entity.",
"com.getperka.flatpack.ext.DeserializationContext:putEntity(java.util.UUID, com.getperka.flatpack.HasUuid, boolean)[0]": "the UUID to assign to the entity",
"com.getperka.flatpack.ext.DeserializationContext:putEntity(java.util.UUID, com.getperka.flatpack.HasUuid, boolean)[1]": "the entity to store in the context",
"com.getperka.flatpack.ext.DeserializationContext:putEntity(java.util.UUID, com.getperka.flatpack.HasUuid, boolean)[2]": "true if the instance was retrieved from an {@link com.getperka.flatpack.ext.EntityResolver EntityResolver}",
"com.getperka.flatpack.ext.DeserializationContext:wasResolved(com.getperka.flatpack.HasUuid)": "Returns true if the entity was obtained via an {@link com.getperka.flatpack.ext.EntityResolver EntityResolver}.",
"com.getperka.flatpack.ext.CodexMapper": "Provides implementations of {@link com.getperka.flatpack.ext.Codex Codex} for various types. Users can inject additional\n CodexMapper implementations into the FlatPack stack via\n {@link com.getperka.flatpack.Configuration:addCodexMapper(com.getperka.flatpack.ext.CodexMapper) Configuration#addCodexMapper(CodexMapper)}.",
"com.getperka.flatpack.ext.CodexMapper:getCodex(com.getperka.flatpack.ext.TypeContext, java.lang.reflect.Type)": "Returns a Codex capable of processing type or null if the mapper does not have\n a suitable Codex. Calls to this method will be cached by {@link com.getperka.flatpack.ext.TypeContext TypeContext}.",
"com.getperka.flatpack.ext.Codex": "Implements type-specific encoding and decoding mechanisms.",
"com.getperka.flatpack.ext.Codex:describe(com.getperka.flatpack.ext.TypeContext)": "Returns a type descriptor for the JSON structure created by the Codex implementation.",
"com.getperka.flatpack.ext.Codex:getPropertySuffix()": "Returns a suffix to append to properties of the Codex's type.",
"com.getperka.flatpack.ext.Codex:isDefaultValue(T)": "Returns true if the value is the default value for an uninitialized instance of a\n property with that value.",
"com.getperka.flatpack.ext.Codex:read(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)": "Reify the given {@link com.google.gson.JsonElement JsonElement} into a Java value. If null value, this method will return null, otherwise this\n method will delegate to {@link com.getperka.flatpack.ext.Codex:readNotNull(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext) DeserializationContext)}.",
"com.getperka.flatpack.ext.Codex:read(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)[0]": "the element that contains the value to reify",
"com.getperka.flatpack.ext.Codex:read(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)[1]": "contextual information for the deserialization process",
"com.getperka.flatpack.ext.Codex:readNotNull(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)": "Reify the given {@link com.google.gson.JsonElement JsonElement} into a Java value.",
"com.getperka.flatpack.ext.Codex:readNotNull(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)[0]": "the element that contains the value to reify",
"com.getperka.flatpack.ext.Codex:readNotNull(com.google.gson.JsonElement, com.getperka.flatpack.ext.DeserializationContext)[1]": "contextual information for the deserialization process",
"com.getperka.flatpack.ext.Codex:scan(T, com.getperka.flatpack.ext.SerializationContext)": "Analyze a composite value to find additional entities to serialize. If object is\n non-null, this method will call {@link com.getperka.flatpack.ext.Codex:scanNotNull(T, com.getperka.flatpack.ext.SerializationContext) SerializationContext)}.",
"com.getperka.flatpack.ext.Codex:scan(T, com.getperka.flatpack.ext.SerializationContext)[0]": "the value to scan",
"com.getperka.flatpack.ext.Codex:scan(T, com.getperka.flatpack.ext.SerializationContext)[1]": "the current serialization context",
"com.getperka.flatpack.ext.Codex:scanNotNull(T, com.getperka.flatpack.ext.SerializationContext)": "Analyze a composite value to find additional entities to serialize. Implementations of this\n method should call {@link com.getperka.flatpack.ext.SerializationContext:add(com.getperka.flatpack.HasUuid) SerializationContext#add(HasUuid)} to enqueue the related entity for\n serialization.",
"com.getperka.flatpack.ext.Codex:scanNotNull(T, com.getperka.flatpack.ext.SerializationContext)[0]": "the object to scan, which is guaranteed to be non-null",
"com.getperka.flatpack.ext.Codex:scanNotNull(T, com.getperka.flatpack.ext.SerializationContext)[1]": "the serialization context",
"com.getperka.flatpack.ext.Codex:write(T, com.getperka.flatpack.ext.SerializationContext)": "Write a value into the serialization context. If object is null, writes a null into\n {@link com.getperka.flatpack.ext.SerializationContext:getWriter() SerializationContext#getWriter()}, otherwise delegates to\n {@link com.getperka.flatpack.ext.Codex:writeNotNull(T, com.getperka.flatpack.ext.SerializationContext) SerializationContext)}.",
"com.getperka.flatpack.ext.Codex:write(T, com.getperka.flatpack.ext.SerializationContext)[0]": "a value to write into {@link com.getperka.flatpack.ext.SerializationContext:getWriter() SerializationContext#getWriter()}",
"com.getperka.flatpack.ext.Codex:write(T, com.getperka.flatpack.ext.SerializationContext)[1]": "the serialization context",
"com.getperka.flatpack.ext.Codex:writeNotNull(T, com.getperka.flatpack.ext.SerializationContext)": "Write a value into the serialization context.",
"com.getperka.flatpack.ext.Codex:writeNotNull(T, com.getperka.flatpack.ext.SerializationContext)[0]": "a value to write into {@link com.getperka.flatpack.ext.SerializationContext:getWriter() SerializationContext#getWriter()}",
"com.getperka.flatpack.ext.Codex:writeNotNull(T, com.getperka.flatpack.ext.SerializationContext)[1]": "the serialization context",
"com.getperka.flatpack.ext.BaseContext": "Contains common data that affects the serialization process.\n \n This class also provides an error-assignment mechanism that tracks the current path of the\n serializer/deserializer through the object graph. When writing a {@link com.getperka.flatpack.ext.Codex Codex} subtype, the\n following pattern should be used:\n \n
\n void read/write(BaseContext context) {\n context.pushPath(\"useful information\");\n try {\n // Do work, possibly utilizing other Codexes\n } catch (CheckedException e) {\n context.fail(e);\n } finally {\n context.popPath();\n }\n }\n ",
"com.getperka.flatpack.ext.BaseContext:addPostWork(java.util.concurrent.Callable)": "Add a Callable to be executed when the (de)-serialization pass is completed. This is used\n primarily for fixing up \"implied\" properties across on-to-many relationships.",
"com.getperka.flatpack.ext.BaseContext:addWarning(com.getperka.flatpack.HasUuid, java.lang.String, java.lang.Object...)": "Add a warning message to be reported via the {@link com.getperka.flatpack.FlatPackEntity FlatPackEntity} being processed.",
"com.getperka.flatpack.ext.BaseContext:fail(java.lang.Throwable)": "Updates the exception's stack trace with the current path elements and performs a \"sneaky\"\n throw to continue to propagate the (checked) exception up the stack.",
"com.getperka.flatpack.ext.BaseContext:getConfiguration()": "Returns the {@link com.getperka.flatpack.Configuration Configuration} in use by the {@link com.getperka.flatpack.FlatPack FlatPack} instance.",
"com.getperka.flatpack.ext.BaseContext:getTypeContext()": "Returns the {@link com.getperka.flatpack.ext.TypeContext TypeContext} in use.",
"com.getperka.flatpack.ext.BaseContext:popPath()": "Removes the topmost path.",
"com.getperka.flatpack.ext.BaseContext:pushPath(java.lang.String)": "Adds a path to the error-reporting stack.",
"com.getperka.flatpack.ext.BaseContext:pushPath(java.lang.String)[0]": "the path element to add",
"com.getperka.flatpack.ext.BaseContext:runPostWork()": "Executes all work items passed ino {@link com.getperka.flatpack.ext.BaseContext:addPostWork(java.util.concurrent.Callable) #addPostWork(Callable)}.",
"com.getperka.flatpack.ext.BaseContext:toString()": "Returns the current error-reporting stack."
}