Index
All Classes and Interfaces|All Packages|Serialized Form
A
- appendIndented(Object, StringBuilder) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Appends the object converted to a string (by calling its
Object.toString()method) after indenting it to the specifiedStringBuilder. - appendIndented(String, StringBuilder) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Appends the given string after indenting it to the specified
StringBuilder. - arrayToString(Object[]) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Converts the specified array to a string.
- AsyncChannelLink<DataType> - Class in org.jtrim2.concurrent.query.io
-
Defines an
AsyncDataLinkwhich allows to read an arbitraryChanneland process its content to be provided as asynchronously. - AsyncChannelLink(TaskExecutor, TaskExecutor, ChannelOpener<? extends ChannelType>, ChannelProcessor<? extends DataType, ChannelType>) - Constructor for class org.jtrim2.concurrent.query.io.AsyncChannelLink
-
Creates a new
AsyncChannelLinkwith the specified executors,ChannelOpenerandChannelProcessor. - AsyncDataController - Interface in org.jtrim2.concurrent.query
-
The
AsyncDataControllerused to control the way the data is provided by anAsyncDataLinkand the state of providing the data. - AsyncDataConverter<InputType,
ResultType> - Class in org.jtrim2.concurrent.query -
Defines a conversion of objects and the
TaskExecutorServicewhich should be used to execute the conversion process. - AsyncDataConverter(DataConverter<InputType, ResultType>, TaskExecutorService) - Constructor for class org.jtrim2.concurrent.query.AsyncDataConverter
-
Creates a new
AsyncDataConverterwith the given conversion routine andTaskExecutorService. - AsyncDataLink<DataType> - Interface in org.jtrim2.concurrent.query
-
Defines a link to asynchronously access a specific data.
- AsyncDataListener<DataType> - Interface in org.jtrim2.concurrent.query
-
Listens for data provided by an
AsyncDataLink. - AsyncDataQuery<QueryArgType,
DataType> - Interface in org.jtrim2.concurrent.query -
Defines an object which can be used to query data based on a specified input.
- AsyncDataState - Interface in org.jtrim2.concurrent.query
-
Defines the progress of the providing of a data provided by an
AsyncDataLink. - AsyncDataTransformer<DataType> - Class in org.jtrim2.concurrent.query
-
Defines a transformation of objects to the same type and the
TaskExecutorServicewhich should be used to execute the transformation process. - AsyncDataTransformer(DataTransformer<DataType>, TaskExecutorService) - Constructor for class org.jtrim2.concurrent.query.AsyncDataTransformer
-
Creates a new
AsyncDataTransformerwith the given transformation routine andTaskExecutorService. - AsyncFormatHelper - Class in org.jtrim2.concurrent.query
-
Contains static helper methods to create consistent string format for
AsyncDataLinkandAsyncDataQueryimplementations. - AsyncHelper - Class in org.jtrim2.concurrent.query
-
Contains useful helper methods for asynchronous data transferring using an
AsyncDataLink. - AsyncLinks - Class in org.jtrim2.concurrent.query
-
Contains static factory methods for useful
AsyncDataLinkimplementations. - AsyncQueries - Class in org.jtrim2.concurrent.query
-
Contains static factory methods for useful
AsyncDataQueryimplementations. - AsyncReport - Class in org.jtrim2.concurrent.query
-
Defines how an asynchronous data transfer has completed.
- AsyncStateReporter<DataType> - Interface in org.jtrim2.concurrent.query
-
Defines the listener which will be notified periodically by the
AsyncDataLinkcreated by theAsyncLinks.createStateReporterLinkmethod.
C
- cacheByID(AsyncDataQuery<? super QueryArgType, ? extends DataType>, ReferenceType, ObjectCache) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates and returns an
AsyncDataQuerywhich createsAsyncDataLinkinstances caching their results and cachesAsyncDataLinkinstances based on a unique ID provided to the query with the input argument. - cacheByID(AsyncDataQuery<? super QueryArgType, ? extends DataType>, ReferenceType, ObjectCache, int) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates and returns an
AsyncDataQuerywhich createsAsyncDataLinkinstances caching their results and cachesAsyncDataLinkinstances based on a unique ID provided to the query with the input argument. - CachedAsyncDataQuery<QueryArgType,
DataType> - Class in org.jtrim2.concurrent.query -
Defines an
AsyncDataQuerywhich cachesAsyncDataLinkinstances based on the input of the query. - CachedByIDAsyncDataQuery<QueryArgType,
DataType> - Class in org.jtrim2.concurrent.query -
Defines an
AsyncDataQuerywhich createsAsyncDataLinkinstances caching their results and cachesAsyncDataLinkinstances based on a unique ID provided to the query with the input argument. - CachedDataRequest<QueryArgType> - Class in org.jtrim2.concurrent.query
-
Defines a request for a data which should be cached if possible.
- CachedDataRequest(QueryArgType) - Constructor for class org.jtrim2.concurrent.query.CachedDataRequest
-
Creates and initializes the
CachedDataRequestwith the given properties. - CachedDataRequest(QueryArgType, ReferenceType) - Constructor for class org.jtrim2.concurrent.query.CachedDataRequest
-
Creates and initializes the
CachedDataRequestwith the given properties. - CachedDataRequest(QueryArgType, ReferenceType, ObjectCache) - Constructor for class org.jtrim2.concurrent.query.CachedDataRequest
-
Creates and initializes the
CachedDataRequestwith the given properties. - CachedDataRequest(QueryArgType, ReferenceType, ObjectCache, long, TimeUnit) - Constructor for class org.jtrim2.concurrent.query.CachedDataRequest
-
Creates and initializes the
CachedDataRequestwith the given properties. - CachedLinkContainer<CacheRefType> - Interface in org.jtrim2.concurrent.query
-
Defines a container for cached
AsyncDataLinkinstances. - CachedLinkRequest<QueryArgType> - Class in org.jtrim2.concurrent.query
-
Defines a request for a data when the
AsyncDataLinkproviding should be cached. - CachedLinkRequest(QueryArgType) - Constructor for class org.jtrim2.concurrent.query.CachedLinkRequest
-
Creates and initializes the
CachedLinkRequestwith the given input for the query and one hour as thecache expire timeoutvalue. - CachedLinkRequest(QueryArgType, long, TimeUnit) - Constructor for class org.jtrim2.concurrent.query.CachedLinkRequest
-
Creates and initializes the
CachedLinkRequestwith the given input for the query and the cache expire timeout value. - cacheLinks(AsyncDataQuery<? super QueryArgType, DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates and returns an
AsyncDataQuerywhich cachesAsyncDataLinkinstances based on the input of the query. - cacheLinks(AsyncDataQuery<? super QueryArgType, DataType>, int) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates and returns an
AsyncDataQuerywhich cachesAsyncDataLinkinstances based on the input of the query. - cacheResult(AsyncDataLink<? extends DataType>, ReferenceType, ObjectCache) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich will return the same datas as the specifiedAsyncDataLinkbut will cache its results. - cacheResult(AsyncDataLink<? extends DataType>, ReferenceType, ObjectCache, long, TimeUnit) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich will return the same datas as the specifiedAsyncDataLinkbut will cache its results. - cacheResults(AsyncDataQuery<? super QueryArgType, ? extends DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates and returns an
AsyncDataQuerywhich createsAsyncDataLinkinstances caching their results. - CANCELED - Static variable in class org.jtrim2.concurrent.query.AsyncReport
-
A canceled but error free data transfer.
- ChannelOpener<ChannelType extends Channel> - Interface in org.jtrim2.concurrent.query.io
-
Defines an interface to open a new
Channelfor processing. - ChannelProcessor<DataType,
ChannelType extends Channel> - Interface in org.jtrim2.concurrent.query.io -
Defines an interface for processing the data of an open
Channeland to forward the processed data to anAsyncDataListener. - ChannelProcessor.StateListener - Interface in org.jtrim2.concurrent.query.io
-
The interface through which the
ChannelProcessormay set the current state of progress of the processing of the channel. - clearCache() - Method in class org.jtrim2.concurrent.query.CachedAsyncDataQuery
-
Removes every
AsyncDataLinkinstances from the cache currently cached by this query. - clearCache() - Method in class org.jtrim2.concurrent.query.CachedByIDAsyncDataQuery
-
Removes every
AsyncDataLinkinstances from the cache currently cached by this query. - clearCache() - Method in interface org.jtrim2.concurrent.query.CachedLinkContainer
-
Removes every
AsyncDataLinkinstances from the cache currently cached by this query. - collectionToString(Collection<?>) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Converts the specified
Collectionto a string. - controlData(Object) - Method in interface org.jtrim2.concurrent.query.AsyncDataController
-
Notifies the
AsyncDataLinkproviding the data, that the data should be provided in a specific way. - controlData(Object) - Method in class org.jtrim2.concurrent.query.DelegatedAsyncDataController
-
Notifies the
AsyncDataLinkproviding the data, that the data should be provided in a specific way. - controlData(Object) - Method in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
Does nothing and returns immediately to the caller.
- controlData(Object) - Method in class org.jtrim2.concurrent.query.InitLaterDataController
-
Notifies the
AsyncDataLinkproviding the data, that the data should be provided in a specific way. - controlData(Object) - Method in class org.jtrim2.concurrent.query.SimpleDataController
-
This method does nothing and returns immediately to the caller.
- convertData(OldDataType) - Method in interface org.jtrim2.concurrent.query.DataConverter
-
Converts the data from one type to another as defined by the implementation.
- convertGradually(InputType, List<? extends AsyncDataConverter<InputType, ResultType>>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates a new
AsyncDataLinkwhich will return the given input data transformed by the specifiedAsyncDataConverter, assuming that subsequent converters in the list provide more and more accurate conversion. - convertResultAsync(AsyncDataLink<? extends OldType>, AsyncDataQuery<? super OldType, ? extends NewType>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates an
AsyncDataLinkwhich will provide the same data as the specifiedAsyncDataLinkbut applies a conversion on the provided data defined by anAsyncDataQuery. - convertResultsAsync(AsyncDataQuery<? super QueryArgType, ? extends OldDataType>, AsyncDataQuery<? super OldDataType, ? extends NewDataType>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates an
AsyncDataQuerywhich will provide the same data as the specifiedAsyncDataQuerybut applies a conversion on the provided data defined by anAsyncDataQuery. - convertResultsSync(AsyncDataQuery<? super QueryArgType, ? extends OldDataType>, DataConverter<? super OldDataType, ? extends NewDataType>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates a new
AsyncDataQuerywhich will provide the same data as the specifiedAsyncDataQuerybut will apply the user defined conversion on the data. - convertResultSync(AsyncDataLink<? extends OldType>, DataConverter<? super OldType, ? extends NewType>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates an
AsyncDataLinkwhich will provide the same data as the specifiedAsyncDataLinkbut applies a conversion on the provided data. - createDataLink(CachedLinkRequest<DataWithUid<QueryArgType>>) - Method in class org.jtrim2.concurrent.query.CachedByIDAsyncDataQuery
-
Returns an
AsyncDataLinkwhich will provide data based on the specified input. - createDataLink(CachedLinkRequest<QueryArgType>) - Method in class org.jtrim2.concurrent.query.CachedAsyncDataQuery
-
Returns an
AsyncDataLinkwhich will provide data based on the specified input. - createDataLink(QueryArgType) - Method in interface org.jtrim2.concurrent.query.AsyncDataQuery
-
Creates a
AsyncDataLinkwhich will provide data based on the specified input. - createPreparedLink(DataType, AsyncDataState) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates and returns an
AsyncDataLinkwhich will provide the given data. - createStateReporterLink(AsyncDataLink<DataType>, AsyncStateReporter<DataType>, long, TimeUnit) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates a new
AsyncDataLinkwhich will provide the exact same data as the specifiedAsyncDataLinkbut will periodically report the state of the data retrieving process. - createStateReporterLink(UpdateTaskExecutor, AsyncDataLink<DataType>, AsyncStateReporter<DataType>, long, TimeUnit) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates a new
AsyncDataLinkwhich will provide the exact same data as the specifiedAsyncDataLinkbut will periodically report the state of the data retrieving process.
D
- DataConverter<OldDataType,
NewDataType> - Interface in org.jtrim2.concurrent.query -
Defines a conversion from one type to another.
- DataInterceptor<DataType> - Interface in org.jtrim2.concurrent.query
-
Defines an interface for intercepting data provided by an
AsyncDataLink. - DataTransferException - Exception in org.jtrim2.concurrent.query
-
An exception defining a general failure of transferring a data asynchronously.
- DataTransferException() - Constructor for exception org.jtrim2.concurrent.query.DataTransferException
-
Creates the exception with
nullas itsdetail message. - DataTransferException(String) - Constructor for exception org.jtrim2.concurrent.query.DataTransferException
-
Creates the exception with a specific
detail message. - DataTransferException(String, Throwable) - Constructor for exception org.jtrim2.concurrent.query.DataTransferException
-
Creates the exception with a specific
detail messageandcause. - DataTransferException(Throwable) - Constructor for exception org.jtrim2.concurrent.query.DataTransferException
-
Creates the exception with a specific
cause. - DataTransformer<DataType> - Interface in org.jtrim2.concurrent.query
-
Defines a transformation of objects.
- DataWithUid<DataType> - Class in org.jtrim2.concurrent.query
-
Defines an object and its ID which uniquely identifies the object within the JVM.
- DataWithUid(DataType) - Constructor for class org.jtrim2.concurrent.query.DataWithUid
- DataWithUid(DataType, Object) - Constructor for class org.jtrim2.concurrent.query.DataWithUid
- DelegatedAsyncDataController - Class in org.jtrim2.concurrent.query
-
An
AsyncDataControllerimplementation which delegates all of its methods to anotherAsyncDataControllerspecified at construction time. - DelegatedAsyncDataController(AsyncDataController) - Constructor for class org.jtrim2.concurrent.query.DelegatedAsyncDataController
-
Initializes the
wrappedControllerfield with the specified argument. - DeserializerChannelProcessor - Class in org.jtrim2.concurrent.query.io
-
Defines a
ChannelProcessorwhich reads and deserializes the first object from the specified channel. - DeserializerChannelProcessor() - Constructor for class org.jtrim2.concurrent.query.io.DeserializerChannelProcessor
-
Creates a new
DeserializerChannelProcessorwhich is ready to read the objects from the provided channel. - DoNothingDataController - Enum Class in org.jtrim2.concurrent.query
E
- equals(Object) - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Checks if the specified object is a
CachedDataRequestand has aquery argumentwhich equals to the query argument of thisCachedDataRequest. - equals(Object) - Method in class org.jtrim2.concurrent.query.DataWithUid
-
Checks whether the passed object is a
DataWithUidand has an equivalent ID or not. - extractCachedResult(AsyncDataLink<RefCachedData<DataType>>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich retrieves thedata partfrom theRefCachedDataresults of the givenAsyncDataLink. - extractCachedResults(AsyncDataQuery<? super QueryArgType, RefCachedData<DataType>>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Creates an
AsyncDataQuerywhich will provide thedata partof the specified query without theVolatileReferenceto it.
F
- FileChannelOpener - Class in org.jtrim2.concurrent.query.io
-
Defines a
ChannelOpenerwhich opens a specific file. - FileChannelOpener(Path) - Constructor for class org.jtrim2.concurrent.query.io.FileChannelOpener
-
Creates a
FileChannelOpenerwhich will open the specified file when requested.
G
- getCacheExpire(TimeUnit) - Method in class org.jtrim2.concurrent.query.CachedLinkRequest
-
Returns the timeout value in the given time unit after an
AsyncDataLinkrequested by this request becomes invalid and must be recreated. - getConverter() - Method in class org.jtrim2.concurrent.query.AsyncDataConverter
-
Returns the data converter object which will carry out the conversion of the input data.
- getData() - Method in class org.jtrim2.concurrent.query.DataWithUid
-
Returns the data specified at construction time.
- getData() - Method in class org.jtrim2.concurrent.query.RefCachedData
-
Returns the data which is referenced by the stored
VolatileReferencereturned by thegetDataRefmethod. - getData(CancellationToken, AsyncDataListener<? super DataType>) - Method in interface org.jtrim2.concurrent.query.AsyncDataLink
-
Starts retrieving the data which is linked to this
AsyncDataLink. - getData(CancellationToken, AsyncDataListener<? super DataType>) - Method in class org.jtrim2.concurrent.query.io.AsyncChannelLink
-
Starts retrieving the data which is linked to this
AsyncDataLink. - getDataCancelTimeout(TimeUnit) - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns the timeout value to wait before actually canceling abandoned data retrieval processes in the given time unit.
- getDataRef() - Method in class org.jtrim2.concurrent.query.RefCachedData
-
Returns the
VolatileReferencereferencing the storeddata. - getDataState() - Method in interface org.jtrim2.concurrent.query.AsyncDataController
-
Returns the current progress of the data providing process.
- getDataState() - Method in class org.jtrim2.concurrent.query.DelegatedAsyncDataController
-
Returns the current progress of the data providing process.
- getDataState() - Method in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
Does nothing and returns
null. - getDataState() - Method in class org.jtrim2.concurrent.query.InitLaterDataController
-
Returns the current progress of the data providing process.
- getDataState() - Method in class org.jtrim2.concurrent.query.SimpleDataController
-
Returns the
AsyncDataStateobject which was last set by thesetDataState()method or the one specified at construction time if there was nosetDataState()call yet. - getException() - Method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns the exception describing the error occurred during the data transfer of which completion this
AsyncReportrepresents. - getExecutor() - Method in class org.jtrim2.concurrent.query.AsyncDataConverter
-
Returns the
TaskExecutorServiceon which the data conversion is intended to be executed. - getExecutor() - Method in class org.jtrim2.concurrent.query.AsyncDataTransformer
-
Returns the
TaskExecutorServiceon which the data transformation is intended to be executed. - getID() - Method in class org.jtrim2.concurrent.query.DataWithUid
-
Returns the ID which is used to determine if two
datais to be considered equivalent. - getIndex() - Method in class org.jtrim2.concurrent.query.OrderedData
-
Returns the index defining how accurate the associated
datais. - getMainControlData() - Method in class org.jtrim2.concurrent.query.LinkedDataControl
-
Returns the control object used to control the primary
AsyncDataLinkinstance. - getObjectCache() - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns the
ObjectCacheused to cache the data to be retrieved. - getProgress() - Method in interface org.jtrim2.concurrent.query.AsyncDataState
-
Returns the estimated state of progress within the range [0.0, 1.0].
- getProgress() - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns an aggregated progress value of the underlying states.
- getProgress() - Method in class org.jtrim2.concurrent.query.SimpleDataState
-
Returns the estimated state of progress within the range [0.0, 1.0].
- getQueryArg() - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns the object used as the input of the query of the data.
- getQueryArg() - Method in class org.jtrim2.concurrent.query.CachedLinkRequest
-
Returns the object used as the input of the query of the data.
- getRawData() - Method in class org.jtrim2.concurrent.query.OrderedData
-
Returns the actual data whose accuracy is described by the
index. - getRefType() - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns the
ReferenceTypeto be used to reference the cached data using theObjectCacheproperty. - getReport(Throwable) - Static method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns an
AsyncReportinstance with the specified exception attached to it and deriving the canceled state from the type of the exception. - getReport(Throwable, boolean) - Static method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns an
AsyncReportinstance with the specified exception attached to it and with the specified canceled state. - getSecondaryControlData() - Method in class org.jtrim2.concurrent.query.LinkedDataControl
-
Returns the control object used to control the secondary
AsyncDataLinkinstance. - getState() - Method in class org.jtrim2.concurrent.query.SimpleDataState
-
Returns the string describing the current state of progress.
- getSubProgress(int) - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns the
progress valueof the underlying state at the given index. - getSubState(int) - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns the underlying state at the given index.
- getSubStateCount() - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns the number of underlying
AsyncDataStateinstances. - getSubStateList() - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns a read-only list of the underlying
AsyncDataStateinstances in the order they were specified at construction time. - getTransferException(Throwable...) - Static method in class org.jtrim2.concurrent.query.AsyncHelper
-
Creates a single
DataTransferExceptionfrom the specified exceptions. - getTransformer() - Method in class org.jtrim2.concurrent.query.AsyncDataTransformer
-
Returns the data transformer object which will carry out the conversion of the input data.
H
- hashCode() - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns a hash code value compatible with the
equalsmethod, usable in hash tables. - hashCode() - Method in class org.jtrim2.concurrent.query.DataWithUid
-
Returns a hash code which can be used in has tables and is compatible with the
equalsmethod.
I
- indentText(String, boolean) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Adds an indentation before every line (optionally the first line can be an exception) of the given string.
- initController(AsyncDataController) - Method in class org.jtrim2.concurrent.query.InitLaterDataController
-
Initializes this
InitLaterDataControllerwith the specifiedAsyncDataControllerto which calls are to be forwarded to. - InitLaterDataController - Class in org.jtrim2.concurrent.query
-
Defines an
AsyncDataControllerwhich forwards every call to a wrappedAsyncDataControllerbut the wrappedAsyncDataControllercan be specified later, after construction time. - InitLaterDataController() - Constructor for class org.jtrim2.concurrent.query.InitLaterDataController
-
Creates the
InitLaterDataControllerwith anullstate of progress objectto return before actuallyinitializedwith anAsyncDataController. - InitLaterDataController(AsyncDataState) - Constructor for class org.jtrim2.concurrent.query.InitLaterDataController
-
Creates the
InitLaterDataControllerwith astate of progress objectto return before actuallyinitializedwith anAsyncDataController. - InputStreamOpener - Interface in org.jtrim2.concurrent.query.io
-
Defines an interface for opening a new input stream for reading.
- INSTANCE - Enum constant in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
The one and only instance of
DoNothingDataController. - interceptData(AsyncDataLink<? extends DataType>, DataInterceptor<? super DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Creates an
AsyncDataLinkwhich will provide the same data as the specifiedAsyncDataLinkbut has a chance to intercept every the data being retrieved. - isCanceled() - Method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns
trueif thisAsyncReportdefines a canceled data transfer. - isSingleLine(String) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Checks whether the specified text contains only a single line.
- isSuccess() - Method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns
trueif thisAsyncReportdefines a completely successful completion of a data transfer.
L
- LinkedDataControl - Class in org.jtrim2.concurrent.query
-
Defines a
control objectforAsyncDataControllerinstances controlling the data retrieval process of twoAsyncDataLinkinstances. - LinkedDataControl(Object, Object) - Constructor for class org.jtrim2.concurrent.query.LinkedDataControl
-
Creates and initializes the
LinkedDataControlinstance with the specified control objects.
M
- makeSafeListener(AsyncDataListener<? super DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncHelper
-
Creates an
AsyncDataListenerwhich forwards data to a specified listener in a thread-safe manner. - makeSafeOrderedListener(AsyncDataListener<? super DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncHelper
-
Creates an
AsyncDataListenerwhich forwards data (with an additional index) to a specified listener in a thread-safe manner. - markResultsWithUid(AsyncDataQuery<? super QueryArgType, ? extends DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
-
Returns an
AsyncDataQuerywhich returns the same results as the specifiedAsyncDataLinkbut creates aDataWithUidobject with a new uniqueIDfrom the provided data of the specifiedAsyncDataQuery. - markResultWithUid(AsyncDataLink<? extends DataType>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich returns the same results as the specifiedAsyncDataLinkbut creates aDataWithUidobject with a new uniqueIDfrom the results of the specifiedAsyncDataLink. - MultiAsyncDataState - Class in org.jtrim2.concurrent.query
-
Defines an aggregate state of progress of multiple data retrieval processes.
- MultiAsyncDataState(List<? extends AsyncDataState>) - Constructor for class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Initializes the
MultiAsyncDataStatewith the specified underlying states. - MultiAsyncDataState(AsyncDataState...) - Constructor for class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Initializes the
MultiAsyncDataStatewith the specified underlying states.
O
- onDataArrive(DataType) - Method in interface org.jtrim2.concurrent.query.AsyncDataListener
-
Invoked when data is available or more detailed information is available.
- onDataArrive(DataType) - Method in interface org.jtrim2.concurrent.query.DataInterceptor
-
Invoked before data is forwarded to the
AsyncDataListener. - onDoneReceive(AsyncReport) - Method in interface org.jtrim2.concurrent.query.AsyncDataListener
-
Invoked after the last data was forwarded to the
onDataArrivemethod. - onDoneReceive(AsyncReport) - Method in interface org.jtrim2.concurrent.query.DataInterceptor
-
Invoked before the
AsyncDataListeneronDoneReceivewas called. - openChanel() - Method in interface org.jtrim2.concurrent.query.io.ChannelOpener
-
Opens a new channel to the source defined by this
ChannelOpenerinstance. - openChanel() - Method in class org.jtrim2.concurrent.query.io.FileChannelOpener
-
Opens a new channel to the source defined by this
ChannelOpenerinstance. - openStream(CancellationToken) - Method in interface org.jtrim2.concurrent.query.io.InputStreamOpener
-
Opens a new stream to the source defined by this
InputStreamOpenerinstance. - OrderedData<DataType> - Class in org.jtrim2.concurrent.query
-
Defines a data with an index which indicates how accurate the data is.
- OrderedData(long, DataType) - Constructor for class org.jtrim2.concurrent.query.OrderedData
- org.jtrim2.concurrent.query - package org.jtrim2.concurrent.query
-
Contains classes and interfaces for asynchronous data retrieval.
- org.jtrim2.concurrent.query.io - package org.jtrim2.concurrent.query.io
-
Contains classes and interface to asynchronously read from channels and streams.
P
- processChannel(ChannelType, AsyncDataListener<DataType>, ChannelProcessor.StateListener) - Method in interface org.jtrim2.concurrent.query.io.ChannelProcessor
-
Processes the content of specified open channel and forwards the processed content to the specified
AsyncDataListener. - processChannel(ReadableByteChannel, AsyncDataListener<Object>, ChannelProcessor.StateListener) - Method in class org.jtrim2.concurrent.query.io.DeserializerChannelProcessor
-
Processes the content of specified open channel and forwards the processed content to the specified
AsyncDataListener.
R
- RefCachedData<DataType> - Class in org.jtrim2.concurrent.query
-
Defines a data and a
VolatileReferenceof the same data. - RefCachedData(DataType, ObjectCache, ReferenceType) - Constructor for class org.jtrim2.concurrent.query.RefCachedData
-
Initializes this
RefCachedDatawith the specifieddataand aVolatileReferenceto the data, created by the specified cache. - RefCachedData(DataType, VolatileReference<DataType>) - Constructor for class org.jtrim2.concurrent.query.RefCachedData
- refCacheResult(AsyncDataLink<? extends DataType>, ReferenceType, ObjectCache) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich will return the same datas as the specifiedAsyncDataLinkbut will cache its results and also return the cached reference. - refCacheResult(AsyncDataLink<? extends DataType>, ReferenceType, ObjectCache, long, TimeUnit) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich will return the same datas as the specifiedAsyncDataLinkbut will cache its results and also return the cached reference. - removeFromCache(CacheRefType) - Method in interface org.jtrim2.concurrent.query.CachedLinkContainer
-
Removes a cached
AsyncDataLinkwhich was cached by the specified input. - removeFromCache(Object) - Method in class org.jtrim2.concurrent.query.CachedByIDAsyncDataQuery
-
Removes a cached
AsyncDataLinkwhich was cached by the specified input. - removeFromCache(QueryArgType) - Method in class org.jtrim2.concurrent.query.CachedAsyncDataQuery
-
Removes a cached
AsyncDataLinkwhich was cached by the specified input. - removeUidFromResult(AsyncDataLink<DataWithUid<DataType>>) - Static method in class org.jtrim2.concurrent.query.AsyncLinks
-
Returns an
AsyncDataLinkwhich retrieves thedata partfrom theDataWithUidresults of the givenAsyncDataLink. - removeUidFromResults(AsyncDataQuery<? super QueryArgType, DataWithUid<DataType>>) - Static method in class org.jtrim2.concurrent.query.AsyncQueries
- reportState(AsyncDataLink<DataType>, AsyncDataListener<? super DataType>, AsyncDataController) - Method in interface org.jtrim2.concurrent.query.AsyncStateReporter
-
The method to be called periodically to be notified of the state of the progress of the data retrieving process.
S
- setDataState(AsyncDataState) - Method in class org.jtrim2.concurrent.query.SimpleDataController
-
Sets the volatile reference to the stored
AsyncDataStateto the one specified. - setState(AsyncDataState) - Method in interface org.jtrim2.concurrent.query.io.ChannelProcessor.StateListener
-
Sets the current state of progress of the processing of the channel.
- SimpleDataController - Class in org.jtrim2.concurrent.query
-
An
AsyncDataControllerimplementation which stores a volatile reference to anAsyncDataStatebut otherwise does nothing. - SimpleDataController() - Constructor for class org.jtrim2.concurrent.query.SimpleDataController
- SimpleDataController(AsyncDataState) - Constructor for class org.jtrim2.concurrent.query.SimpleDataController
-
Initializes the
SimpleDataControllerwith the specifiedstate of progress. - SimpleDataState - Class in org.jtrim2.concurrent.query
-
Defines an
AsyncDataStatewith a specific double value as the state of progress and a string describing the current state. - SimpleDataState(String, double) - Constructor for class org.jtrim2.concurrent.query.SimpleDataState
-
Initializes the
SimpleDataStatewith the specified string describing the current state of progress and a double value within the range [0.0, 1.0] describing the estimated numerical state of progress. - SublistenerException - Exception in org.jtrim2.concurrent.query
-
An exception describing unexpected failure in one or more
AsyncDataListener. - SublistenerException() - Constructor for exception org.jtrim2.concurrent.query.SublistenerException
-
Creates the exception with
nullas itsdetail message. - SublistenerException(String) - Constructor for exception org.jtrim2.concurrent.query.SublistenerException
-
Creates the exception with a specific
detail message. - SublistenerException(String, Throwable) - Constructor for exception org.jtrim2.concurrent.query.SublistenerException
-
Creates the exception with a specific
detail messageandcause. - SublistenerException(Throwable) - Constructor for exception org.jtrim2.concurrent.query.SublistenerException
-
Creates the exception with a specific
cause. - submit(CancellationToken, DataType) - Method in class org.jtrim2.concurrent.query.AsyncDataTransformer
-
Submits a task to the wrapped
executorwhich will carry out thedata transformation routine. - submit(CancellationToken, InputType) - Method in class org.jtrim2.concurrent.query.AsyncDataConverter
-
Submits a task to the wrapped
executorwhich will carry out thedata conversion routine. - SUCCESS - Static variable in class org.jtrim2.concurrent.query.AsyncReport
-
A completely successful data transfer.
T
- toIndentedString(Object, boolean) - Static method in class org.jtrim2.concurrent.query.AsyncFormatHelper
-
Converts the specified object to string (using its
toStringmethod) and returns this string after applying an indentation. - toString() - Method in class org.jtrim2.concurrent.query.AsyncDataConverter
-
Returns the string representation of this
AsyncDataConverterin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.AsyncDataTransformer
-
Returns the string representation of this
AsyncDataTransformerin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.AsyncReport
-
Returns the string representation of this
AsyncReportin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.CachedAsyncDataQuery
-
Returns the string representation of this
AsyncDataQueryin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.CachedByIDAsyncDataQuery
-
Returns the string representation of this
AsyncDataQueryin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.CachedDataRequest
-
Returns the string representation of this
CachedDataRequestin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.CachedLinkRequest
-
Returns the string representation of this
CachedLinkRequestin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.DataWithUid
-
Returns the string representation of this
DataWithUidin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.DelegatedAsyncDataController
- toString() - Method in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
Returns the string representation of this
DoNothingDataControllerin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.InitLaterDataController
-
Returns the string representation of this
InitLaterDataControllerin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.LinkedDataControl
-
Returns the string representation of this
LinkedDataControlin no particular format. - toString() - Method in class org.jtrim2.concurrent.query.MultiAsyncDataState
-
Returns the string representation of this
MultiAsyncDataStatein no particular format. - toString() - Method in class org.jtrim2.concurrent.query.OrderedData
-
Returns the string representation of this
OrderedDatain no particular format. - toString() - Method in class org.jtrim2.concurrent.query.RefCachedData
-
Returns the string representation of this
RefCachedDatain no particular format. - toString() - Method in class org.jtrim2.concurrent.query.SimpleDataState
-
Returns the string representation of this
SimpleDataStatein no particular format. - transform(DataType) - Method in interface org.jtrim2.concurrent.query.DataTransformer
-
Transforms the data as defined by the implementation.
V
- valueOf(String) - Static method in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.jtrim2.concurrent.query.DoNothingDataController
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- wrappedController - Variable in class org.jtrim2.concurrent.query.DelegatedAsyncDataController
-
The
AsyncDataControllerto which the methods are forwarded.
All Classes and Interfaces|All Packages|Serialized Form