Index (Arez-Persist API Documentation)

A C D E F G I L N P R S T
All Classes and Interfaces|All Packages|Constant Field Values

A

APPLICATION - Static variable in class arez.persist.StoreTypes: The property is persisted in memory and will be lost when the application is reloaded.
arez.persist - package arez.persist: Arez-Persist annotations and constants.
arez.persist.processor - package arez.persist.processor: Processor for the arez.persist annotations.
arez.persist.runtime - package arez.persist.runtime: Arez-Persist runtime infrastructure.
arez.persist.runtime.browser - package arez.persist.runtime.browser: Browser-specific runtime infrastructure.
ArezPersist - Class in arez.persist.runtime: Provide an interface to register and access stores and access the root scope as well as global configuration settings.
ArezPersistBrowserUtil - Class in arez.persist.runtime.browser
ArezPersistProcessor - Class in arez.persist.processor: Annotation processor that analyzes Arez annotated source and generates models from the annotations.
ArezPersistProcessor() - Constructor for class arez.persist.processor.ArezPersistProcessor
ArezPersistTestUtil - Class in arez.persist.runtime: Utility class for interacting with ArezPersist config settings in tests.
ArezPersistTestUtil.Logger - Interface in arez.persist.runtime: Interface to intercept log messages emitted by ArezPersist runtime.

C

checkApiInvariants() - Static method in class arez.persist.runtime.ArezPersistTestUtil: Set the `arez.persist.check_api_invariants` setting to true.
collectStopWatches(Collection<StopWatch>) - Method in class arez.persist.processor.ArezPersistProcessor
commit(Map<Scope, Map<String, Map<String, StorageService.Entry>>>) - Method in interface arez.persist.runtime.StorageService: Invoked by the store to save the state to the storage service.
Converter<A,E> - Interface in arez.persist.runtime: Converter that encodes a persistent property from application form to encoded form and back again.

D

decode(E) - Method in interface arez.persist.runtime.Converter: Decode encoded value into form used by the application.
decode(String, E) - Method in class arez.persist.runtime.TypeConverter: Decode encoded value into form used by the application.
decodeState(Object, TypeConverter) - Method in interface arez.persist.runtime.StorageService: Decode state from backend storage form.
defaultStore() - Element in annotation interface arez.persist.PersistType: The key identifying the default store where the observable data is stored.
disableApplicationStore() - Static method in class arez.persist.runtime.ArezPersistTestUtil: Set the `arez.persist.enable_application_store` setting to false.
dispose() - Method in interface arez.persist.runtime.StorageService: Dispose the service.
disposeScope(Scope) - Static method in class arez.persist.runtime.ArezPersist: Dispose the specified scope.

E

enableApplicationStore() - Static method in class arez.persist.runtime.ArezPersistTestUtil: Set the `arez.persist.enable_application_store` setting to true.
encode(A) - Method in interface arez.persist.runtime.Converter: Encode value into form used by the storage system.
encode(String, A) - Method in class arez.persist.runtime.TypeConverter: Encode value into form used by the storage system.
encodeState(Map<String, Object>, TypeConverter) - Method in interface arez.persist.runtime.StorageService: Encode state in a way that makes storage to the backend easier.
Entry(Map<String, Object>, Object) - Constructor for class arez.persist.runtime.StorageService.Entry

F

findOrCreateScope(String) - Static method in class arez.persist.runtime.ArezPersist: Find the scope with the specified name and if it does not exist then create it.
findOrCreateScope(String) - Method in class arez.persist.runtime.Scope: Find or create a scope directly nested under the current scope.
findScope(String) - Static method in class arez.persist.runtime.ArezPersist: Find the scope with the specified name.

G

get(Scope, String, String, TypeConverter) - Method in class arez.persist.runtime.Store: Retrieve the state for a single component from the store.
getConverter(Class<A>) - Static method in class arez.persist.runtime.ArezPersist: Return the converter registered for the specified application type or the identity converter if none are specified.
getData() - Method in class arez.persist.runtime.StorageService.Entry: Return the decoded data.
getEncoded() - Method in class arez.persist.runtime.StorageService.Entry: Return the encoded data.
getIssueTrackerURL() - Method in class arez.persist.processor.ArezPersistProcessor
getName() - Method in class arez.persist.runtime.Scope: Return the simple name of the scope.
getNestedScopes() - Method in class arez.persist.runtime.Scope
getOptionPrefix() - Method in class arez.persist.processor.ArezPersistProcessor
getQualifiedName() - Method in class arez.persist.runtime.Scope: Return the qualified name of the scope.
getRootScope() - Static method in class arez.persist.runtime.ArezPersist: Return the root scope under which all other scopes are nested.
getStore(String) - Static method in class arez.persist.runtime.ArezPersist: Return the store that is registered with the specified name.

I

isApplicationStoreEnabled() - Static method in class arez.persist.runtime.ArezPersist: Return true if the in-memory application store should be registered by the framework.
isDisposed() - Method in class arez.persist.runtime.Store: Return true if this service has been disposed.

L

LOCAL - Static variable in class arez.persist.StoreTypes: The property is persisted when using the same browser.
log(String, Throwable) - Method in interface arez.persist.runtime.ArezPersistTestUtil.Logger

N

name() - Element in annotation interface arez.persist.Persist: Return the name used to persist the property.
name() - Element in annotation interface arez.persist.PersistType: Return the name used to persist the type.
noCheckApiInvariants() - Static method in class arez.persist.runtime.ArezPersistTestUtil: Set the `arez.persist.check_api_invariants` setting to false.

P

Persist - Annotation Interface in arez.persist: Annotation applied to observable properties that direct Arez to persist the property.
PersistId - Annotation Interface in arez.persist: Annotation applied to method that returns the a value to identify the instance of the type.
persistOnDispose() - Element in annotation interface arez.persist.PersistType: Setting controlling whether the sidecar attempts to force a persist of state when the sidecar is disposed.
PersistType - Annotation Interface in arez.persist: Annotation applied to arez components that triggers the generation of persistence code.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class arez.persist.processor.ArezPersistProcessor

R

registerByteConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a byte converter that is useful when converting to json representation.
registerCharacterConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a character converter that is useful when converting to json representation.
registerConverter(Class<A>, Converter<A, ?>) - Static method in class arez.persist.runtime.ArezPersist: Register a converter for a type.
registerFloatConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a Float converter that is useful when converting to json representation.
registerIntegerConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a Integer converter that is useful when converting to json representation.
registerLocalStore(String) - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a store under the StoreTypes.LOCAL name that saves state in a browsers local storage.
registerLongConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a Long converter that is useful when converting to json representation.
registerSessionStore(String) - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a store under the StoreTypes.SESSION name that saves state in a browsers session storage.
registerShortConverter() - Static method in class arez.persist.runtime.browser.ArezPersistBrowserUtil: Register a Short converter that is useful when converting to json representation.
registerStore(String, StorageService) - Static method in class arez.persist.runtime.ArezPersist: Register a store with specified name and storage service.
releaseScope(Scope) - Static method in class arez.persist.runtime.ArezPersist: Release the specified scope.
remove(Scope, String, String) - Method in class arez.persist.runtime.Store: Remove the state for a single component from the store.
resetConfig(boolean) - Static method in class arez.persist.runtime.ArezPersistTestUtil: Reset the state of ArezPersist config to either production or development state.
resetState() - Static method in class arez.persist.runtime.ArezPersistTestUtil: Reset the state of ArezPersist.
restore(Map<Scope, Map<String, Map<String, StorageService.Entry>>>) - Method in interface arez.persist.runtime.StorageService: Restore state from the service into the specified state parameter.
ROOT_SCOPE_NAME - Static variable in class arez.persist.runtime.Scope: The name of the root scope.

S

save(Scope, String, String, Map<String, Object>, TypeConverter) - Method in class arez.persist.runtime.Store: Save the state for a single component to the store.
scheduleCommit(SafeProcedure) - Method in interface arez.persist.runtime.StorageService: Method invoked when state has changed.
Scope - Class in arez.persist.runtime: A scope is used to control the lifecycle of state storage.
SESSION - Static variable in class arez.persist.StoreTypes: The property is persisted across the session.
setLogger(ArezPersistTestUtil.Logger) - Static method in class arez.persist.runtime.ArezPersistTestUtil: Specify logger to use to capture logging in tests
setterName() - Element in annotation interface arez.persist.Persist: Return the name of the setter.
shouldCheckApiInvariants() - Static method in class arez.persist.runtime.ArezPersist: Return true if apiInvariants will be checked.
StorageService - Interface in arez.persist.runtime: Interface implemented to provide the state storage and retrieval services.
StorageService.Entry - Class in arez.persist.runtime: An entry containing the state for a particular component.
store() - Element in annotation interface arez.persist.Persist: The key identifying the store where the observable data is stored.
Store - Class in arez.persist.runtime: The store that contains a cached copy of any state persisted.
StoreTypes - Class in arez.persist: A class containing constants for persistence stores supplied by the library.

T

toString() - Method in class arez.persist.runtime.Scope
toString() - Method in class arez.persist.runtime.StorageService.Entry
TypeConverter - Class in arez.persist.runtime: A converter that encodes properties for a specific type.
TypeConverter(Map<String, Converter>) - Constructor for class arez.persist.runtime.TypeConverter

A C D E F G I L N P R S T
All Classes and Interfaces|All Packages|Constant Field Values