|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Generated(value="com.neeve.adm.AdmGenerator", date="Wed Mar 28 10:54:30 EDT 2018") @AdmGenerated(compatLevel="3.8.0", admVersion="nvx-adm v3.7.265 (build 0)", date="3/28/18 10:54 AM", buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)") public interface ISrvMonAppEngineStoppingMessage
Event notifying an AEP application that its engine is about to be stopped.
This event is dispatched to an application to notify it that the AEP engine is about to be stopped.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode |
---|
IRogNode.PoolingListener |
Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject |
---|
IStoreObject.EncodingType |
Method Summary | ||
---|---|---|
void |
clearCause()
Clears the value of 'cause' Field Description The cause of the event. |
|
void |
clearPreserveChannelJoins()
Clears the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. |
|
void |
clearTimestamp()
Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch). |
|
SrvMonAppEngineStoppingMessage |
copy()
Creates a copy of this SrvMonAppEngineStoppingMessage. |
|
void |
copyInto(SrvMonAppEngineStoppingMessage target)
Copies the contents of this SrvMonAppEngineStoppingMessage into the target. |
|
String |
getCause()
Gets the value of 'cause' Field Description The cause of the event. |
|
|
getCauseTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getCauseTo(XString val)
Copies the value of 'cause' into the provided XString. |
|
XString |
getCauseUnsafe()
Gets the raw value of 'cause'. |
|
boolean |
getPreserveChannelJoins()
Gets the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. |
|
long |
getTimestamp()
Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch). |
|
boolean |
hasCause()
Checks for the presence of 'cause' Field Description The cause of the event. |
|
boolean |
hasPreserveChannelJoins()
Checks for the presence of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. |
|
boolean |
hasTimestamp()
Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch). |
|
void |
lendCause(XString val)
Sets the value of 'cause' Field Description The cause of the event. |
|
void |
setCause(String val)
Sets the value of 'cause' Field Description The cause of the event. |
|
void |
setCauseFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setCauseFrom(XString val)
Copies the provided XString value into this object's 'cause'. |
|
void |
setPreserveChannelJoins(boolean val)
Sets the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. |
|
void |
setTimestamp(long val)
Sets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch). |
Methods inherited from interface com.neeve.ods.IStoreObject |
---|
acquire, deserialize, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, setId, setStableTransactionId, setTransactionId |
Methods inherited from interface com.neeve.sma.MapMessageView |
---|
getMessageReflector |
Methods inherited from interface com.neeve.rog.IRogValidatable |
---|
getValidationErrors, isValid |
Method Detail |
---|
void setTimestamp(long val)
val
- The value to set.long getTimestamp()
void clearTimestamp()
setTimestamp(long)
boolean hasTimestamp()
getTimestamp()
void setPreserveChannelJoins(boolean val)
Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.
val
- The value to set.boolean getPreserveChannelJoins()
Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.
void clearPreserveChannelJoins()
Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.
setPreserveChannelJoins(boolean)
boolean hasPreserveChannelJoins()
Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.
getPreserveChannelJoins()
void setCause(String val)
val
- The value to set.String getCause()
void lendCause(XString val)
val
- The value to set.void setCauseFrom(long val)
NOTE:
This is the same as calling setCause(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getCauseTo(XString.Factory<T> factory)
If the value of this field is not null
this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
factory
- The factory from which to get the XString to copy into and return
null
.
NullPointerException
- if the provided factory is nullvoid setCauseFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setCause(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
void getCauseTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getCause()
bec
because it can avoid decoding the value into an String
.
getCause()
XString getCauseUnsafe()
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getCause()
void clearCause()
setCause(String)
boolean hasCause()
getCause()
SrvMonAppEngineStoppingMessage copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppEngineStoppingMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppEngineStoppingMessage is read only.
No metadata is copied except as documented IRogCopyableNode
.
See IRogCopyableNode
for more detailed information on the semantics of this method.
copy
in interface CopyableMessageView<ISrvMonAppEngineStoppingMessage>
copy
in interface IRogCopyableNode<ISrvMonAppEngineStoppingMessage>
IRogCopyableNode
,
CopyableMessageView
void copyInto(SrvMonAppEngineStoppingMessage target)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppEngineStoppingMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppEngineStoppingMessage is read only.
No metadata is copied except as documented IRogCopyableNode
.
See IRogCopyableNode
for more detailed information on the semantics of this method.
target
- The target to copy into which must not be null or read only.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |