|Modifier and Type||Interface and Description|
Contents of a replay.
|Modifier and Type||Field and Description|
|Modifier and Type||Method and Description|
Constructs a replay from the given replay specification.
Gets and returns a replay.
Returns the version of the replay parser engine.
Parses a replay from a file.
static final java.lang.String VERSION
IReplay parseReplay(java.lang.String fileName, java.util.Set<ReplayFactoryApi.ReplayContent> contentToParseSet)
fileName- name of the replay file
contentToParseSet- set of replay content to parse; general replay info is always parsed besides the content denoted by this set
nullif replay parse failed
IReplay constructReplay(ReplaySpecification replaySpec)
IReplay getReplay(java.lang.String fileName, java.util.Set<ReplayFactoryApi.ReplayContent> contentToParseSet)
This method first tries to get the replay from the Replay cache. If the replay is in the cache, it will be returned.
If the replay is not in the cache, the replay will be parsed with the specified optional
parseReplay(String, Set). If
contentToParseSet is specified and is "wide" enough to parse
enough information required by the cache, the parsed replay will be cached after the parsing and will be available
from the cache next time.
You can use
IReplay.getReplayOrigin() to tell where the returned replay was taken from
(e.g. from the replay cache, or it was parsed from the replay file).
Attention! The replay cache contains limited information about a replay. Only use cached replays if the cached
information is sufficient for you. What you gain in return is much-much faster replay data access.
Here is an incomplete list of information that is stored in the replay cache:
fileName- name of the replay file to be loaded/parsed
contentToParseSet- optional replay content set to be parsed if cache does not contain the replay (if the replay is cached, the cached info will be returned), if not specified (
null), a set of
ReplayFactoryApi.ReplayContent.MESSAGE_EVENTSwill be used
nullif replay is not in the cache (or failed to read the cache) and replay parse failed