Class Syslog5424Listener

java.lang.Object

com.github.palindromicity.syslog.dsl.generated.Rfc5424BaseListener

com.github.palindromicity.syslog.dsl.Syslog5424Listener

All Implemented Interfaces:

Rfc5424Listener, org.antlr.v4.runtime.tree.ParseTreeListener

public class Syslog5424Listener
extends Rfc5424BaseListener

Simple implementation of Rfc5424Listener.

Syslog5424Listener populates a Map with the values parsed from a valid RFC 5424 syslog line. Nil ('-') values are handled according the NilPolicy.

The Syslog5424Listener uses the provided KeyProvider when inserting items into the map.

Constructor Summary

Constructors

Constructor	Description
Syslog5424Listener(KeyProvider keyProvider)	Create a new Syslog5424Listener.
Syslog5424Listener(KeyProvider keyProvider, NilPolicy nilPolicy, StructuredDataPolicy structuredDataPolicy)	Create a new Syslog5424Listener.
Syslog5424Listener(KeyProvider keyProvider, NilPolicy nilPolicy, StructuredDataPolicy structuredDataPolicy, EnumSet<AllowableDeviations> deviations)	Create a new Syslog5424Listener.

Method Summary

Modifier and Type	Method	Description
void	exitHeaderAppName(Rfc5424Parser.HeaderAppNameContext ctx)	Exit a parse tree produced by the headerAppName labeled alternative in Rfc5424Parser.app_name().
void	exitHeaderHostName(Rfc5424Parser.HeaderHostNameContext ctx)	Exit a parse tree produced by the headerHostName labeled alternative in Rfc5424Parser.hostname().
void	exitHeaderMsgId(Rfc5424Parser.HeaderMsgIdContext ctx)	Exit a parse tree produced by the headerMsgId labeled alternative in Rfc5424Parser.msgid().
void	exitHeaderNilAppName(Rfc5424Parser.HeaderNilAppNameContext ctx)	Exit a parse tree produced by the headerNilAppName labeled alternative in Rfc5424Parser.app_name().
void	exitHeaderNilHostName(Rfc5424Parser.HeaderNilHostNameContext ctx)	Exit a parse tree produced by the headerNilHostName labeled alternative in Rfc5424Parser.hostname().
void	exitHeaderNilMsgId(Rfc5424Parser.HeaderNilMsgIdContext ctx)	Exit a parse tree produced by the headerNilMsgId labeled alternative in Rfc5424Parser.msgid().
void	exitHeaderNilProcId(Rfc5424Parser.HeaderNilProcIdContext ctx)	Exit a parse tree produced by the headerNilProcId labeled alternative in Rfc5424Parser.procid().
void	exitHeaderNilTimestamp(Rfc5424Parser.HeaderNilTimestampContext ctx)	Exit a parse tree produced by the headerNilTimestamp labeled alternative in Rfc5424Parser.timestamp().
void	exitHeaderPriorityValue(Rfc5424Parser.HeaderPriorityValueContext ctx)	Exit a parse tree produced by the headerPriorityValue labeled alternative in Rfc5424Parser.prival().
void	exitHeaderProcId(Rfc5424Parser.HeaderProcIdContext ctx)	Exit a parse tree produced by the headerProcId labeled alternative in Rfc5424Parser.procid().
void	exitHeaderTimeStamp(Rfc5424Parser.HeaderTimeStampContext ctx)	Exit a parse tree produced by the headerTimeStamp labeled alternative in Rfc5424Parser.timestamp().
void	exitHeaderVersion(Rfc5424Parser.HeaderVersionContext ctx)	Exit a parse tree produced by the headerVersion labeled alternative in Rfc5424Parser.version().
void	exitMsg_utf8(Rfc5424Parser.Msg_utf8Context ctx)	Exit a parse tree produced by Rfc5424Parser.msg_utf8().
void	exitSdElement(Rfc5424Parser.SdElementContext ctx)	Exit a parse tree produced by the sdElement labeled alternative in Rfc5424Parser.sd_element().
Map<String,Object>	getMsgMap()	Returns the Map of syslog values with the keys as provided by the KeyProvider.

Methods inherited from class com.github.palindromicity.syslog.dsl.generated.Rfc5424BaseListener

enterBom, enterDate_fullyear, enterDate_mday, enterDate_month, enterEveryRule, enterFull_date, enterFull_time, enterHeaderAppName, enterHeaderHostName, enterHeaderMsgId, enterHeaderNilAppName, enterHeaderNilHostName, enterHeaderNilMsgId, enterHeaderNilProcId, enterHeaderNilTimestamp, enterHeaderPriority, enterHeaderPriorityValue, enterHeaderProcId, enterHeaderTimeStamp, enterHeaderVersion, enterMsg_utf8, enterMsgUTF8, enterNilvalue, enterNonzero_digit, enterNonZeroDigit, enterOctet, enterParamName, enterParamValue, enterPartial_time, enterPrintusascii, enterPrintusasciinospecials, enterSd_id, enterSd_name, enterSdElement, enterSdParam, enterSp, enterStructured_data, enterSyslogHeader, enterSyslogMsg, enterTime_hour, enterTime_minute, enterTime_numoffset, enterTime_offset, enterTime_secfrac, enterTime_second, enterUtf_8_string, enterZeroDigit, exitBom, exitDate_fullyear, exitDate_mday, exitDate_month, exitEveryRule, exitFull_date, exitFull_time, exitHeaderPriority, exitMsgUTF8, exitNilvalue, exitNonzero_digit, exitNonZeroDigit, exitOctet, exitParamName, exitParamValue, exitPartial_time, exitPrintusascii, exitPrintusasciinospecials, exitSd_id, exitSd_name, exitSdParam, exitSp, exitStructured_data, exitSyslogHeader, exitSyslogMsg, exitTime_hour, exitTime_minute, exitTime_numoffset, exitTime_offset, exitTime_secfrac, exitTime_second, exitUtf_8_string, exitZeroDigit, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object

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

Constructor Details

Syslog5424Listener

public Syslog5424Listener(KeyProvider keyProvider)

Create a new Syslog5424Listener.

Parameters:

keyProvider - KeyProvider used for map insertion.

Syslog5424Listener

public Syslog5424Listener(KeyProvider keyProvider,
 NilPolicy nilPolicy,
 StructuredDataPolicy structuredDataPolicy)

Create a new Syslog5424Listener.

Parameters:

keyProvider - KeyProvider used for map insertion.

nilPolicy - NilPolicy used for handling nil values.

structuredDataPolicy - StructuredDataPolicy used for handling Structured Data output.

Syslog5424Listener

public Syslog5424Listener(KeyProvider keyProvider,
 NilPolicy nilPolicy,
 StructuredDataPolicy structuredDataPolicy,
 EnumSet<AllowableDeviations> deviations)

Create a new Syslog5424Listener.

Parameters:

keyProvider - KeyProvider used for map insertion.

nilPolicy - NilPolicy used for handling nil values.

structuredDataPolicy - StructuredDataPolicy used for handling Structured Data output.

deviations - AllowableDeviations used for handling abnormalities.

Method Details

getMsgMap

public Map<String,Object> getMsgMap()

Returns the Map of syslog values with the keys as provided by the KeyProvider. The map returned is unmodifiable.

Returns:

unmodifiable Map

exitHeaderPriorityValue

public void exitHeaderPriorityValue(Rfc5424Parser.HeaderPriorityValueContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerPriorityValue labeled alternative in Rfc5424Parser.prival().

The default implementation does nothing.

Specified by:

exitHeaderPriorityValue in interface Rfc5424Listener

Overrides:

exitHeaderPriorityValue in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderVersion

public void exitHeaderVersion(Rfc5424Parser.HeaderVersionContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerVersion labeled alternative in Rfc5424Parser.version().

The default implementation does nothing.

Specified by:

exitHeaderVersion in interface Rfc5424Listener

Overrides:

exitHeaderVersion in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderHostName

public void exitHeaderHostName(Rfc5424Parser.HeaderHostNameContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerHostName labeled alternative in Rfc5424Parser.hostname().

The default implementation does nothing.

Specified by:

exitHeaderHostName in interface Rfc5424Listener

Overrides:

exitHeaderHostName in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderNilHostName

public void exitHeaderNilHostName(Rfc5424Parser.HeaderNilHostNameContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerNilHostName labeled alternative in Rfc5424Parser.hostname().

The default implementation does nothing.

Specified by:

exitHeaderNilHostName in interface Rfc5424Listener

Overrides:

exitHeaderNilHostName in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderAppName

public void exitHeaderAppName(Rfc5424Parser.HeaderAppNameContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerAppName labeled alternative in Rfc5424Parser.app_name().

The default implementation does nothing.

Specified by:

exitHeaderAppName in interface Rfc5424Listener

Overrides:

exitHeaderAppName in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderNilAppName

public void exitHeaderNilAppName(Rfc5424Parser.HeaderNilAppNameContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerNilAppName labeled alternative in Rfc5424Parser.app_name().

The default implementation does nothing.

Specified by:

exitHeaderNilAppName in interface Rfc5424Listener

Overrides:

exitHeaderNilAppName in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderProcId

public void exitHeaderProcId(Rfc5424Parser.HeaderProcIdContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerProcId labeled alternative in Rfc5424Parser.procid().

The default implementation does nothing.

Specified by:

exitHeaderProcId in interface Rfc5424Listener

Overrides:

exitHeaderProcId in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderNilProcId

public void exitHeaderNilProcId(Rfc5424Parser.HeaderNilProcIdContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerNilProcId labeled alternative in Rfc5424Parser.procid().

The default implementation does nothing.

Specified by:

exitHeaderNilProcId in interface Rfc5424Listener

Overrides:

exitHeaderNilProcId in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderMsgId

public void exitHeaderMsgId(Rfc5424Parser.HeaderMsgIdContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerMsgId labeled alternative in Rfc5424Parser.msgid().

The default implementation does nothing.

Specified by:

exitHeaderMsgId in interface Rfc5424Listener

Overrides:

exitHeaderMsgId in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderNilMsgId

public void exitHeaderNilMsgId(Rfc5424Parser.HeaderNilMsgIdContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerNilMsgId labeled alternative in Rfc5424Parser.msgid().

The default implementation does nothing.

Specified by:

exitHeaderNilMsgId in interface Rfc5424Listener

Overrides:

exitHeaderNilMsgId in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderTimeStamp

public void exitHeaderTimeStamp(Rfc5424Parser.HeaderTimeStampContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerTimeStamp labeled alternative in Rfc5424Parser.timestamp().

The default implementation does nothing.

Specified by:

exitHeaderTimeStamp in interface Rfc5424Listener

Overrides:

exitHeaderTimeStamp in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitHeaderNilTimestamp

public void exitHeaderNilTimestamp(Rfc5424Parser.HeaderNilTimestampContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the headerNilTimestamp labeled alternative in Rfc5424Parser.timestamp().

The default implementation does nothing.

Specified by:

exitHeaderNilTimestamp in interface Rfc5424Listener

Overrides:

exitHeaderNilTimestamp in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitSdElement

public void exitSdElement(Rfc5424Parser.SdElementContext ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by the sdElement labeled alternative in Rfc5424Parser.sd_element().

The default implementation does nothing.

Specified by:

exitSdElement in interface Rfc5424Listener

Overrides:

exitSdElement in class Rfc5424BaseListener

Parameters:

ctx - the parse tree

exitMsg_utf8

public void exitMsg_utf8(Rfc5424Parser.Msg_utf8Context ctx)

Description copied from class: Rfc5424BaseListener

Exit a parse tree produced by Rfc5424Parser.msg_utf8().

The default implementation does nothing.

Specified by:

exitMsg_utf8 in interface Rfc5424Listener

Overrides:

exitMsg_utf8 in class Rfc5424BaseListener

Parameters:

ctx - the parse tree