Package com.e1c.langtool.internal.history.provider

Class BaseTranslationProvider.TranslationResult

java.lang.Object

com.e1c.langtool.internal.history.provider.BaseTranslationProvider.TranslationResult

All Implemented Interfaces:

IPageIterable<IPage<IProjectTranslation>>, IHistoryTranslationProvider.ITranslationResult, Iterable<IPage<IProjectTranslation>>

Enclosing class:

BaseTranslationProvider

public static class BaseTranslationProvider.TranslationResult
extends Object
implements IHistoryTranslationProvider.ITranslationResult

Constructor Summary

Constructors

Constructor	Description
TranslationResult(IProjectTranslationStorage translationService, IExpression query, long totalSize, String value)

Method Summary

Modifier and Type	Method	Description
Iterator<IPage<IProjectTranslation>>	iterator()	Returns an iterator over of pages that contain translations.
Iterator<IPage<IProjectTranslation>>	iterator(int pageSize)	Returns an iterator over of pages that contain translations with the specified page size.
long	totalCount()	Returns the total count of translation which have been found for the query.
String	value()	The result of translation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

TranslationResult

public TranslationResult(IProjectTranslationStorage translationService,
 IExpression query,
 long totalSize,
 String value)

Method Details

iterator

public Iterator<IPage<IProjectTranslation>> iterator(int pageSize)

Description copied from interface: IHistoryTranslationProvider.ITranslationResult

Returns an iterator over of pages that contain translations with the specified page size.

This method returns an iterator that allows to iterate over pages with translations in lazy way. Unlike IHistoryTranslationProvider.ITranslationResult.iterator() this method allows users to specify the size of iterable pages.

Note that implementators of this interface may realize the lazy way of page loading through iterating so it's recommended avoiding a redundant passes over iterator because of overhead for creating the iterator and loading pages.

Specified by:

iterator in interface IHistoryTranslationProvider.ITranslationResult

Specified by:

iterator in interface IPageIterable<IPage<IProjectTranslation>>

Parameters:

pageSize - the size of iterable pages

Returns:

an iterator of pages (must be positive)

See Also:

• IHistoryTranslationProvider.ITranslationResult.iterator()

iterator

public Iterator<IPage<IProjectTranslation>> iterator()

Description copied from interface: IHistoryTranslationProvider.ITranslationResult

Returns an iterator over of pages that contain translations.

This method returns an iterator that allows to iterate over pages with translations in lazy way. The page size is defined by implementators of this interface. To define the size of iterating pages use the IHistoryTranslationProvider.ITranslationResult.iterator(int) method.

Note that implementators of this interface may realize the lazy way of page loading through iterating so it's recommended avoiding a redundant passes over iterator because of overhead for creating the iterator and loading pages.

Specified by:

iterator in interface IHistoryTranslationProvider.ITranslationResult

Specified by:

iterator in interface Iterable<IPage<IProjectTranslation>>

Returns:

an iterator of pages

See Also:

• Iterable.iterator()
• IHistoryTranslationProvider.ITranslationResult.iterator(int)

totalCount

public long totalCount()

Description copied from interface: IHistoryTranslationProvider.ITranslationResult

Returns the total count of translation which have been found for the query.

Specified by:

totalCount in interface IHistoryTranslationProvider.ITranslationResult

Returns:

the total count of translation (must be positive)

value

public String value()

Description copied from interface: IHistoryTranslationProvider.ITranslationResult

The result of translation.

The implementors of this interface must provide that the result of translation returned from this method must be the same with all translations contained in iterable pages returned from iterators (see IHistoryTranslationProvider.ITranslationResult.iterator() and IHistoryTranslationProvider.ITranslationResult.iterator(int) methods).

Specified by:

value in interface IHistoryTranslationProvider.ITranslationResult

Returns:

the translation result (must not be null)