Class fever.conf.ParserQueue

Description

Queue structure to store configuration parser.

Used by the Configuration class only.

You can customize configuration parsing using addType() method.

Events support :

See Also

Field Index

onParsingChangeEVENT, onParsingCompleteEVENT, onParsingProgressEVENT, onParsingStartEVENT

Method Index

new ParserQueue()
addListener(), addType(), execute(), isEmpty(), isRunning(), onParserComplete(), onParserProgress(), onParserStart(), onParserUpdate(), removeListener(), removeType()

Constructor Detail

ParserQueue

public function ParserQueue()

Constructor.

Field Detail

onParsingStartEVENT

static public onParsingStartEVENT:EventType
Broadcasted when configuration parsing starts.

onParsingChangeEVENT

static public onParsingChangeEVENT:EventType
Broadcasted when a new ConfigurationParser parser type starts confiuration parsing.

onParsingProgressEVENT

static public onParsingProgressEVENT:EventType
Broadcasted when a new LibParser parser type progress.

onParsingCompleteEVENT

static public onParsingCompleteEVENT:EventType
Broadcasted when configuration parsing is complete.

Method Detail

addType

public function addType(parser:ConfigurationParser):Void

Adds passed-in parser as configuration parser.

Parameters

parserA ConfigurationParser instance

removeType

public function removeType(parser:ConfigurationParser):Void

Removes passed-in parser from configuration parser list.

Parameters

parserA ConfigurationParser instance

execute

public function execute():Void

Starts process.

If a parsing is already running, do nothing.

isEmpty

public function isEmpty():Boolean

Returns true if parser queue is empty.

isRunning

public function isRunning():Boolean

Returns true if parsing process is running.

addListener

public function addListener(listener:ParserQueueListener):Void

Adds passed-in listener for receiving all events.

Parameters

listenerParserQueueListener

removeListener

public function removeListener(listener:ParserQueueListener):Void

Removes passed-in listener for receiving all events.

Parameters

listenerParserQueueListener

onParserStart

public function onParserStart(event:IEvent):Void

Triggered by the internal process to indicate that a new ConfigurationParser parser starts parsing.

onParserUpdate

public function onParserUpdate(event:IEvent):Void

Triggered by the internal process to indicate that a new ConfigurationParser parser starts parsing.

onParserProgress

public function onParserProgress(event:StringEvent):Void

Triggered by the internal process to indicate that a new LibParser parser progress.

onParserComplete

public function onParserComplete(event:IEvent):Void

Triggered by the internal process to indicate that a parser has finished is job.

Checks the queue to know if other parser must be execute.

as2api