hu.scelightapi.sc2.rep.factory

Interface IRepParserEngine

public interface IRepParserEngine

Replay parser engine interface to parse replays or load/cache replay processors.

Author:

Andras Belicza

See Also:

IReplay, IRepProcessor

Method Summary

Methods

Modifier and Type	Method and Description
IVersionBean	getRepParserEngineVersionBean() Returns the version bean of the replay parser engine.
IRepProcessor	getRepProc(java.nio.file.Path file) Returns an IRepProcessor constructed and initialized from the replay processor's cache for the specified replay file if it is cached, and if not, it will be parsed and cached first, then returned.
IVersionBean	getRepProcCacheVersionBean() Returns the version bean of the replay processor cache.
IVersionBean	getRepProcessorVersionBean() Returns the version bean of the replay processor.
IRepProcessor	parseAndWrapReplay(java.nio.file.Path file) Parses the specified replay file and returns a wrapper IRepProcessor object.
IReplay	parseReplay(java.nio.file.Path file) Parses the specified replay file and returns an IReplay object.

Method Detail

getRepParserEngineVersionBean

IVersionBean getRepParserEngineVersionBean()

Returns the version bean of the replay parser engine.

Returns:

the version bean of the replay parser engine.

getRepProcessorVersionBean

IVersionBean getRepProcessorVersionBean()

Returns the version bean of the replay processor.

Returns:

the version bean of the replay processor

getRepProcCacheVersionBean

IVersionBean getRepProcCacheVersionBean()

Returns the version bean of the replay processor cache.

Returns:

the version bean of the replay processor cache

parseReplay

IReplay parseReplay(java.nio.file.Path file)

Parses the specified replay file and returns an IReplay object.

If the complete game events and tracker events of the replay are not required, the preferred way to "parse" the replay is getRepProc(Path) because it is significantly faster, the difference is order of magnitude!

Parameters:

file - replay file to be parsed

Returns:

the constructed IReplay object or null if the replay cannot be parsed

See Also:

IReplay, getRepProc(Path), parseAndWrapReplay(Path)

parseAndWrapReplay

IRepProcessor parseAndWrapReplay(java.nio.file.Path file)

Parses the specified replay file and returns a wrapper IRepProcessor object.

If the complete game events and tracker events of the replay are not required, the preferred way to "parse" the replay is getRepProc(Path) because it is significantly faster, the difference is order of magnitude!

Parameters:

file - replay file to be parsed

Returns:

a wrapper IRepProcessor of the constructed IReplay object or null if the replay cannot be parsed

See Also:

IReplay, getRepProc(Path)

getRepProc

IRepProcessor getRepProc(java.nio.file.Path file)

Returns an IRepProcessor constructed and initialized from the replay processor's cache for the specified replay file if it is cached, and if not, it will be parsed and cached first, then returned.

If the complete game events and tracker events of the replay are not required, this is the preferred way to "parse" the replay as opposed to parseReplay(Path) because this method is significantly faster, the difference is order of magnitude!

Parameters:

file - replay file whose IRepProcessor object to return

Returns:

an IRepProcessor preferably constructed and initialized from the replay processor's cache or null if the replay cannot be parsed

See Also:

IRepProcessor, parseReplay(Path), parseAndWrapReplay(Path)