hu.scelightapi.service

Interface IFactory

public interface IFactory

General factory interface.

Used to create new instances of certain API interfaces.

Author:

Andras Belicza

See Also:

IGuiFactory

Method Summary

Methods

Modifier and Type	Method and Description
IVersionBean	getRepSearchEngineVersionBean() Returns the version of the replay search engine.
IVersionBean	getTemplateEngineVersionBean() Returns the version bean of the template engine.
IControlledThread	newControlledThread(java.lang.String name, java.lang.Runnable runnable) Creates a new IControlledThread with the specified name which executes the specified runnable.
IDateValue	newDateValue(java.util.Date value) Creates a new IMMUTABLE IDateValue with IDateFormat.DATE_TIME format hint.
IDateValue	newDateValue(java.util.Date value, IDateFormat dateFormat) Creates a new IMMUTABLE IDateValue.
IDurationValue	newDurationValue(long value) Creates a new IMMUTABLE IDurationValue with IDurationFormat.AUTO format hint.
IDurationValue	newDurationValue(long value, IDurationFormat durationFormat) Creates a new IMMUTABLE IDurationValue.
<T> IHolder<T>	newHolder() Returns a new IHolder
<T> IHolder<T>	newHolder(T value) Returns a new IHolder
IHttpPost	newHttpPost(java.net.URL url, java.util.Map<java.lang.String,java.lang.String> paramsMap) Creates a new IHttpPost.
IJob	newJob(java.lang.String name, IRIcon ricon, java.lang.Runnable runnable) Creates a new IJob with the specified name, IRIcon and which executes the specified runnable.
INormalThread	newNormalThread(java.lang.String name, java.lang.Runnable runnable) Creates and a new INormalThread with the specified name which executes the specified runnable.
<T1,T2> IPair<T1,T2>	newPair(T1 value1, T2 value2) Creates a new IMMUTABLE IPair.
IProgressJob	newProgressJob(java.lang.String name, IRIcon ricon, java.lang.Runnable runnable) Creates a new IProgressJob with the specified name, IRIcon and which executes the specified runnable.
IRelativeDate	newRelativeDate(java.util.Date date) Creates a new IMMUTABLE IRelativeDate.
IRelativeDate	newRelativeDate(java.util.Date date, boolean longForm, int tokens, boolean appendEra) Creates a new IMMUTABLE IRelativeDate.
IRelativeDate	newRelativeDate(long date) Creates a new IMMUTABLE IRelativeDate.
IRelativeDate	newRelativeDate(long date, boolean longForm, int tokens, boolean appendEra) Creates a new IMMUTABLE IRelativeDate.
IRepFilterBean	newRepFilterBean() Creates a new IRepFilterBean and initializes it with default values.
IRepFiltersBean	newRepFiltersBean() Creates a new IRepFiltersBean.
IRepFiltersEditorDialog	newRepFiltersEditorDialog(IRepFiltersBean repFiltersBean) Creates a new IRepFiltersEditorDialog.
IRepSearchEngine	newRepSearchEngine(IRepFiltersBean repFiltersBean) Creates a new IRepSearchEngine.
ISelectionTracker	newSelectionTracker() Creates a new ISelectionTracker.
IFileProvider	newSimpleFileProvider(java.nio.file.Path file, java.lang.Long lastModified) Creates a new IFileProvider which always returns the specified file and last modified time.
ISizeValue	newSizeValue(long value) Creates a new IMMUTABLE ISizeValue with ISizeFormat.AUTO format hint.
ISizeValue	newSizeValue(long value, ISizeFormat sizeFormat) Creates a new IMMUTABLE ISizeValue.
ITemplateEngine	newTemplateEngine(java.lang.String template) Creates a new ITemplateEngine.
IToon	newToon(java.lang.String toon) Creates a new IToon from the specified toon string.
IToon	newToon(java.lang.String toon, boolean parsePlayerName) Creates a new IToon from the specified toon string.
IUrlBuilder	newUrlBuilder(java.net.URL url) Creates a new IUrlBuilder from the specified base URL.
IVersionView	newVersionView(int... parts) Creates a new IVersionView from the specified parts.
IVersionView	newVersionView(java.lang.String version) Creates a new IVersionView from the specified version string.

Method Detail

newUrlBuilder

IUrlBuilder newUrlBuilder(java.net.URL url)
                          throws java.lang.IllegalArgumentException

Creates a new IUrlBuilder from the specified base URL.

Parameters:

url - base URL to extend, may contain a query part but must not contain a reference part

Returns:

a new IUrlBuilder

Throws:

java.lang.IllegalArgumentException - if the specified URL contains a reference part

See Also:

newHttpPost(URL, Map)

newHttpPost

IHttpPost newHttpPost(java.net.URL url,
                    java.util.Map<java.lang.String,java.lang.String> paramsMap)

Creates a new IHttpPost.

Parameters:

url - URL to post to

paramsMap - map of parameters to be sent

Returns:

an IHttpPost to interact with the HTTP POST request

See Also:

IHttpPost, newUrlBuilder(URL)

newSimpleFileProvider

IFileProvider newSimpleFileProvider(java.nio.file.Path file,
                                  java.lang.Long lastModified)

Creates a new IFileProvider which always returns the specified file and last modified time.

Parameters:

file - the provided file

lastModified - last modified date of the provided file

Returns:

an IFileProvider which always returns the specified file and last modified time

See Also:

IHttpPost

newVersionView

IVersionView newVersionView(int... parts)

Creates a new IVersionView from the specified parts.

Parameters:

parts - parts of the version

Returns:

a new IVersionView from the specified parts

See Also:

IVersionView, newVersionView(String)

newVersionView

IVersionView newVersionView(java.lang.String version)

Creates a new IVersionView from the specified version string.

Parameters:

version - version string to create a version view from

Returns:

a new IVersionView from the specified version string, or null if the specified string is not a valid version string

See Also:

IVersionView, newVersionView(int...)

newToon

IToon newToon(java.lang.String toon)
              throws java.lang.IllegalArgumentException

Creates a new IToon from the specified toon string.

The format of the toon string is exactly as specified by IToon.toString().

Parameters:

toon - toon string to create the IToon from

Returns:

a new IToon from the specified toon string

Throws:

java.lang.IllegalArgumentException - if the specified toon string is invalid

See Also:

IToon, newToon(String, boolean)

newToon

IToon newToon(java.lang.String toon,
            boolean parsePlayerName)
              throws java.lang.IllegalArgumentException

Creates a new IToon from the specified toon string.

The format of the toon string is exactly as specified by IToon.toString().

Parameters:

toon - toon string to create the IToon from

parsePlayerName - tells if player name is to be parsed from the toon string if present

Returns:

a new IToon from the specified toon string

Throws:

java.lang.IllegalArgumentException - if the specified toon string is invalid

Since:

1.4

See Also:

IToon, newToon(String)

newNormalThread

INormalThread newNormalThread(java.lang.String name,
                            java.lang.Runnable runnable)

Creates and a new INormalThread with the specified name which executes the specified runnable.

The returned normal thread is not started. It has to be started with the INormalThread.start() method.

Parameters:

name - name of the thread

runnable - runnable to execute in the returned normal thread

Returns:

a new INormalThread

See Also:

INormalThread, newControlledThread(String, Runnable)

newControlledThread

IControlledThread newControlledThread(java.lang.String name,
                                    java.lang.Runnable runnable)

Creates a new IControlledThread with the specified name which executes the specified runnable.

The returned controlled thread is not started. It has to be started with the INormalThread.start() method.

Parameters:

name - name of the thread

runnable - runnable to execute in the returned controlled thread

Returns:

a new IControlledThread

See Also:

IControlledThread, newNormalThread(String, Runnable)

newJob

IJob newJob(java.lang.String name,
          IRIcon ricon,
          java.lang.Runnable runnable)

Creates a new IJob with the specified name, IRIcon and which executes the specified runnable.

The returned job is not started. It has to be started with the INormalThread.start() method.

Parameters:

name - name of the job

ricon - ricon of the job

runnable - runnable to execute in the returned job

Returns:

a new IJob

See Also:

IJob, newProgressJob(String, IRIcon, Runnable), IGuiFactory.newRIcon(URL)

newProgressJob

IProgressJob newProgressJob(java.lang.String name,
                          IRIcon ricon,
                          java.lang.Runnable runnable)

Creates a new IProgressJob with the specified name, IRIcon and which executes the specified runnable.

The returned progress job is not started. It has to be started with the INormalThread.start() method.

Parameters:

name - name of the progress job

ricon - ricon of the progress job

runnable - runnable to execute in the returned progress job

Returns:

a new IProgressJob

See Also:

IProgressJob, newJob(String, IRIcon, Runnable), IGuiFactory.newRIcon(URL)

getTemplateEngineVersionBean

IVersionBean getTemplateEngineVersionBean()

Returns the version bean of the template engine.

Returns:

the version bean of the template engine

newTemplateEngine

ITemplateEngine newTemplateEngine(java.lang.String template)
                                  throws IInvalidTemplateException

Creates a new ITemplateEngine.

This method can also be used to validate a template string. If no exception is thrown, the template is valid.

Parameters:

template - template string

Returns:

a new ITemplateEngine

Throws:

IInvalidTemplateException - if the specified template is invalid

See Also:

ITemplateEngine

newRepFiltersBean

IRepFiltersBean newRepFiltersBean()

Creates a new IRepFiltersBean.

Returns:

a new IRepFiltersBean

See Also:

IRepFiltersBean, IRepFiltersEditorDialog, newRepFilterBean()

newRepFilterBean

IRepFilterBean newRepFilterBean()

Creates a new IRepFilterBean and initializes it with default values.

Returns:

a new IRepFilterBean

See Also:

IRepFilterBean, IRepFiltersEditorDialog, newRepFiltersBean()

newRepFiltersEditorDialog

IRepFiltersEditorDialog newRepFiltersEditorDialog(IRepFiltersBean repFiltersBean)

Creates a new IRepFiltersEditorDialog.

The dialog is made visible immediately and this method only returns when the dialog is already closed. Whether filters were edited can be checked with the IRepFiltersEditorDialog.isOk() method, and the edited filters can be retrieved with the IRepFiltersEditorDialog.getRepFiltersBean() (which may or may not be the same as the passed filters even if you specified it).

Parameters:

repFiltersBean - optional replay filters to be viewed / edited in the dialog; if null, a new IRepFiltersBean will be created

Returns:

a new IRepFiltersEditorDialog

See Also:

IRepFiltersEditorDialog, IRepFiltersBean, IRepFilterBean

getRepSearchEngineVersionBean

IVersionBean getRepSearchEngineVersionBean()

Returns the version of the replay search engine.

Returns:

the version of the replay search engine

newRepSearchEngine

IRepSearchEngine newRepSearchEngine(IRepFiltersBean repFiltersBean)

Creates a new IRepSearchEngine.

Parameters:

repFiltersBean - replay filters bean to search / filter by

Returns:

a new IRepSearchEngine

See Also:

IRepSearchEngine, IRepFiltersEditorDialog, newRepFiltersBean(), newRepFilterBean()

newDurationValue

IDurationValue newDurationValue(long value)

Creates a new IMMUTABLE IDurationValue with IDurationFormat.AUTO format hint.

Parameters:

value - time duration value in milliseconds

Returns:

a new IDurationValue

See Also:

IDurationValue, newDurationValue(long, IDurationFormat)

newDurationValue

IDurationValue newDurationValue(long value,
                              IDurationFormat durationFormat)

Creates a new IMMUTABLE IDurationValue.

Parameters:

value - time duration value in milliseconds

durationFormat - duration format hint for renderers

Returns:

a new IDurationValue

See Also:

IDurationValue, IDurationFormat

newSizeValue

ISizeValue newSizeValue(long value)

Creates a new IMMUTABLE ISizeValue with ISizeFormat.AUTO format hint.

Parameters:

value - size value in bytes

Returns:

a new ISizeValue

See Also:

ISizeValue, newSizeValue(long, ISizeFormat)

newSizeValue

ISizeValue newSizeValue(long value,
                      ISizeFormat sizeFormat)

Creates a new IMMUTABLE ISizeValue.

Parameters:

value - size value in bytes

sizeFormat - size format hint for renderers

Returns:

a new ISizeValue

See Also:

ISizeValue, ISizeFormat

newDateValue

IDateValue newDateValue(java.util.Date value)

Creates a new IMMUTABLE IDateValue with IDateFormat.DATE_TIME format hint.

Parameters:

value - date value

Returns:

a new IDateValue

Since:

1.1

See Also:

IDateValue, newDateValue(Date, IDateFormat)

newDateValue

IDateValue newDateValue(java.util.Date value,
                      IDateFormat dateFormat)

Creates a new IMMUTABLE IDateValue.

Parameters:

value - date value

dateFormat - date format hint for renderers

Returns:

a new IDateValue

Since:

1.1

See Also:

IDateValue, IDateFormat

newHolder

<T> IHolder<T> newHolder()

Returns a new IHolder

Type Parameters:

T - type of the held object

Returns:

a new IHolder

See Also:

IHolder

newHolder

<T> IHolder<T> newHolder(T value)

Returns a new IHolder

Type Parameters:

T - type of the held object

Parameters:

value - the reference to be set as the held object

Returns:

a new IHolder

See Also:

IHolder

newRelativeDate

IRelativeDate newRelativeDate(java.util.Date date)

Creates a new IMMUTABLE IRelativeDate.

Parameters:

date - absolute date to be represented relatively to the current time

Returns:

a new IRelativeDate

See Also:

IRelativeDate, newRelativeDate(long), newRelativeDate(Date, boolean, int, boolean), newRelativeDate(long, boolean, int, boolean)

newRelativeDate

IRelativeDate newRelativeDate(long date)

Creates a new IMMUTABLE IRelativeDate.

Parameters:

date - absolute date to be represented relatively to the current time

Returns:

a new IRelativeDate

See Also:

IRelativeDate, newRelativeDate(Date), newRelativeDate(Date, boolean, int, boolean), newRelativeDate(long, boolean, int, boolean)

newRelativeDate

IRelativeDate newRelativeDate(java.util.Date date,
                            boolean longForm,
                            int tokens,
                            boolean appendEra)

Creates a new IMMUTABLE IRelativeDate. See IRelativeDate.toString(boolean, int, boolean) for details.

Parameters:

date - absolute date to be represented relatively to the current time

longForm - tells if long form is to be used for time units

tokens - tells how many tokens to include

appendEra - tells if era is to be appended; era is "ago" for past times and "from now" for future times

Returns:

a new IRelativeDate

See Also:

IRelativeDate, newRelativeDate(long, boolean, int, boolean), IRelativeDate.toString(boolean, int, boolean)

newRelativeDate

IRelativeDate newRelativeDate(long date,
                            boolean longForm,
                            int tokens,
                            boolean appendEra)

Creates a new IMMUTABLE IRelativeDate. See IRelativeDate.toString(boolean, int, boolean) for details.

Parameters:

date - absolute date to be represented relatively to the current time

longForm - tells if long form is to be used for time units

tokens - tells how many tokens to include

appendEra - tells if era is to be appended; era is "ago" for past times and "from now" for future times

Returns:

a new IRelativeDate

See Also:

IRelativeDate, newRelativeDate(Date, boolean, int, boolean), IRelativeDate.toString(boolean, int, boolean)

newPair

<T1,T2> IPair<T1,T2> newPair(T1 value1,
                           T2 value2)

Creates a new IMMUTABLE IPair.

Type Parameters:

T1 - type of the first object

T2 - type of the second object

Parameters:

value1 - the first object

value2 - the second object

Returns:

a new IPair

See Also:

IPair

newSelectionTracker

ISelectionTracker newSelectionTracker()

Creates a new ISelectionTracker.

Returns:

a new ISelectionTracker

Since:

1.3

See Also:

ISelectionTracker