Class TransformerPermissionImpl
- All Implemented Interfaces:
DSData
,DSPacket
,DSPermission
,DSSerializable
,TransformerData
,TransformerPermission
,TransformerFlags
,Iterable<DSField>
-
Field Summary
Fields inherited from class com.caplin.transformer.module.datasrc.TransformerDataImpl
modCount
Fields inherited from interface com.caplin.datasrc.interfaces.DSData
CONTAINER_TYPE, F_AUTH_UPDATE, F_AUTHGLOBAL, F_CHANGEDFIELDS, F_CLEAR_PERMISSIONS, F_CLEAR_TYPE2, F_CLEAR_TYPE3, F_CREATEOBJECT, F_CREATEPARENT, F_DELETE_PERMISSION, F_FILTER_TYPE2, F_FILTER_TYPE3, F_IMAGE, F_NONACTIVE, GENERIC_TYPE, NEWS_TYPE, PAGE_TYPE, PERMISSION_TYPE, RECORD_TYPE, STORY_TYPE, TYPE2_RECORD_TYPE, TYPE3_RECORD_TYPE, UNKNOWN_TYPE
Fields inherited from interface com.caplin.datasrc.interfaces.DSPermission
DS_FIELDS_SEPARATOR
Fields inherited from interface com.caplin.transformer.module.TransformerFlags
MAINTAIN_TIMESTAMP, NO_FLAGS, NO_PERSISTENCE, PUBLISH_TO_PEERS, SILENT_SEND, STORE_IN_CACHE
-
Constructor Summary
ModifierConstructorDescriptionprotected
TransformerPermissionImpl
(long dsDataPointer) Constructor is protected to prevent a TransformerPermission being instantiated except by the DSFactory class.protected
TransformerPermissionImpl
(long dsDataPointer, boolean freeDsDataPointer) Constructor is protected to prevent a TransformerPermission being instantiated except by the DSFactory class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addKeyField
(String key) Adds the String key as the Keyfield for this packet.void
addPermissionData
(String fieldName, char value) Adds the String representation of the character value for the specified field name.void
addPermissionData
(String fieldName, char[] value) Adds the String representation of the character array for the specified field name.void
addPermissionData
(String fieldName, double value) Adds the String representation of the double value for the specified field name.void
addPermissionData
(String fieldName, float value) Adds the String representation of the float value for the specified field name.void
addPermissionData
(String fieldName, int value) Adds the String representation of the integer value for the specified field name.void
addPermissionData
(String fieldName, long value) Adds the String representation of the long value for the specified field name.void
addPermissionData
(String fieldName, String value) Adds the String value for the specified field name.void
Adds a separator allowing the cojoining of multiple permission updates into a single packet.void
Adds a seperator allowing the cojoining of multiple permission updates into a single packet.Methods inherited from class com.caplin.transformer.module.datasrc.TransformerDataImpl
addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addData, addData, addData, addData, addData, addData, addData, addData, addString, addString, clearFields, count, elements, finalize, getDSDataPointer, getFieldByFieldNumber, getFieldByFieldNumber, getFlags, getKeys, getObjectType, getSequenceNumber, getSubject, getType, getValues, iterator, merge, removeField, send, send, sendDirect, sendToPeer, setFlags, setSubject, setType, setType, toBytes, updateData, updateData
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.caplin.datasrc.interfaces.DSData
addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addData, addData, addData, addData, addData, addData, addData, addData, clearFields, count, elements, getFieldByFieldNumber, getFieldByFieldNumber, getFlags, getKeys, getSubject, getType, getValues, iterator, removeField, setFlags, setSubject, setType, updateData, updateData
Methods inherited from interface com.caplin.datasrc.interfaces.DSPacket
send, sendDirect, sendToPeer
Methods inherited from interface com.caplin.datasrc.interfaces.DSSerializable
toBytes
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface com.caplin.transformer.module.datasrc.TransformerData
getDSDataPointer, getObjectType, getSequenceNumber, merge, send, setType
-
Constructor Details
-
TransformerPermissionImpl
protected TransformerPermissionImpl(long dsDataPointer) Constructor is protected to prevent a TransformerPermission being instantiated except by the DSFactory class.
A TransformerPermission created with this constructor will be responsible for freeing the memory for the underlying C ds_data struct.
This is equivalent to calling TransformerPermission(dsDataPointer, false).
- Parameters:
dsDataPointer
- The pointer to the C ds_data struct that holds the state information for the update.
-
TransformerPermissionImpl
protected TransformerPermissionImpl(long dsDataPointer, boolean freeDsDataPointer) Constructor is protected to prevent a TransformerPermission being instantiated except by the DSFactory class.
- Parameters:
dsDataPointer
- The pointer to the C ds_data struct that holds the state information for the update.freeDsDataPointer
- true if the TransformerPermission is responsible for freeing up the memory for the C ds_data struct, or false if the Transformer core is responsible.
-
-
Method Details
-
addKeyField
Description copied from interface:DSPermission
Adds the String key as the Keyfield for this packet.
This should only be called as the first call to a DSPermission or after a call toDSPermission.addPermissionSeperator()
- Specified by:
addKeyField
in interfaceDSPermission
- Parameters:
key
- The permission key
-
addPermissionData
Description copied from interface:DSPermission
Adds the String value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the character value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the character array for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the double value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the float value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the integer value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionData
Description copied from interface:DSPermission
Adds the String representation of the long value for the specified field name.
- Specified by:
addPermissionData
in interfaceDSPermission
- Parameters:
fieldName
- The field name.value
- The value to be stored in the field.
-
addPermissionSeparator
public void addPermissionSeparator()Description copied from interface:DSPermission
Adds a separator allowing the cojoining of multiple permission updates into a single packet.
After this method is invoked, the user should invoke the addKeyField method.- Specified by:
addPermissionSeparator
in interfaceDSPermission
-
addPermissionSeperator
public void addPermissionSeperator()Description copied from interface:DSPermission
Adds a seperator allowing the cojoining of multiple permission updates into a single packet.
After this method is invoked, the user should invoke the addKeyField method.- Specified by:
addPermissionSeperator
in interfaceDSPermission
-