pt.lsts.imc

Class CacheControl

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.CacheControl

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class CacheControl
extends IMCMessage

IMC Message Cache Control (101)
Control caching of messages to persistent storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheControl.OP

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
CacheControl()
CacheControl(CacheControl.OP op, java.lang.String snapshot, IMCMessage message)
CacheControl(IMCDefinition defs)
CacheControl(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static CacheControl	clone(IMCMessage msg)
static CacheControl	create(java.lang.Object... values)
IMCMessage	getMessage()
<T extends IMCMessage> T	getMessage(java.lang.Class<T> clazz)
CacheControl.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
java.lang.String	getSnapshot()
CacheControl	setMessage(IMCMessage message)
CacheControl	setOp(CacheControl.OP op)
CacheControl	setOpStr(java.lang.String op)
CacheControl	setOpVal(short op)
CacheControl	setSnapshot(java.lang.String snapshot)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

CacheControl

public CacheControl()

CacheControl

public CacheControl(IMCMessage msg)

CacheControl

public CacheControl(IMCDefinition defs)

CacheControl

public CacheControl(CacheControl.OP op,
                    java.lang.String snapshot,
                    IMCMessage message)

Method Detail

create

public static CacheControl create(java.lang.Object... values)

clone

public static CacheControl clone(IMCMessage msg)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getOp

public CacheControl.OP getOp()

Returns:

Control Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public CacheControl setOp(CacheControl.OP op)

Parameters:

op - Control Operation (enumerated)

setOpStr

public CacheControl setOpStr(java.lang.String op)

Parameters:

op - Control Operation (as a String)

setOpVal

public CacheControl setOpVal(short op)

Parameters:

op - Control Operation (integer value)

getSnapshot

public java.lang.String getSnapshot()

Returns:

Snapshot destination - plaintext

setSnapshot

public CacheControl setSnapshot(java.lang.String snapshot)

Parameters:

snapshot - Snapshot destination

getMessage

public IMCMessage getMessage()

Returns:

Message - message

getMessage

public <T extends IMCMessage> T getMessage(java.lang.Class<T> clazz)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

setMessage

public CacheControl setMessage(IMCMessage message)

Parameters:

message - Message