ClassContent

java.lang.Object
- org.vishia.inspectorTarget.ClassContent

All Implemented Interfaces:

CmdConsumer_ifc
```
public final class ClassContent
extends java.lang.Object
implements CmdConsumer_ifc
```
Implements the commands to get fields and values from data and sets values.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) byte[]`	`__TEST__`
`private AnswerComm_ifc`	`answerComm` Association to produce the answer of a request.
`private InspcDataExchangeAccess.Inspcitem`	`answerItem` Access element for `ByteDataAccessBase` to the answer Item.
`MemAccessArrayDebugJc`	`debugRemoteAccess` Yet only a placeholder, used in the C-implementation.
`(package private) InspcDataInfo[]`	`handles` Array of registered data access info items.
`private MemSegmJc`	`rootAddr` For C usage: It can be in an extended memory area.
`private ClassJc`	`rootClass` The class to the rootAddr.
`(package private) InspcDataInfo`	`test` java2c=simpleRef.
`private java.lang.StringBuilder`	`uAnswer` Buffer to prepare the answer in the answer of a telegram.
`private java.lang.StringBuilder`	`uArray` Buffer to prepare a array information in the answer of a telegram.
`private java.lang.StringBuilder`	`uValue` Buffer to prepare the value in the answer of a telegram.
`(package private) static java.lang.String`	`version` Version, history and license.
`private java.lang.Object`	`XXXrootObj` The Object from which the user-given path starts to search.

Constructor Summary

Constructors
Constructor and Description

ClassContent()

Constructors
Constructor and Description
`ClassContent()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addAnswerItemValueByHandle(InspcDataExchangeAccess.InspcDatagram answer, InspcDataExchangeAccess.InspcAnswerValueByHandle answItem, int sizeExpected)`
`private int`	`cmdGetAddressByPath(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes)`
`private int`	`cmdGetFields(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes)`
`(package private) int`	`cmdGetValueByHandle(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes)`
`private int`	`cmdGetValueByPath(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer)`
`(package private) int`	`cmdRegisterRepeat(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes)`
`private int`	`cmdSetValueByPath(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer)`
`private void`	`completeAnswerItemByHandle(InspcDataExchangeAccess.InspcAnswerValueByHandle answItem, int indexTo, int nOrderNr)`
`private void`	`evaluateFieldGetFields(InspcDataExchangeAccess.InspcDatagram answer, FieldJc field, int orderNr, int maxNrofAnswerBytes)`
`private void`	`evaluateFieldGetFields(InspcDataExchangeAccess.InspcDatagram answer, java.lang.String name, ClassJc typeField, int modifiers, int staticArraySize, int orderNr, int maxNrofAnswerBytes)`
`int`	`executeMonitorCmd(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes)` Executes a command, writes the answer in the answer datagram.
`float`	`getFloatValueByHandle(int handle)` Gets the value described by this handle as float value.
`int`	`getIntValueByHandle(int handle)` Gets the value described by this handle as int32 value.
`private static short`	`getSetValue(FieldJc theField, int idx, MemSegmJc theObject, InspcDataExchangeAccess.InspcSetValue accSetValue, InspcDataExchangeAccess.Inspcitem answerItem, boolean bStoreTypeInAnswer)` Sets the value if accSetValue is not null, fills the `answerItem` with the read value.
`void`	`getSetValueByPath(int nOrderNr, java.lang.String sVariablePath, InspcDataExchangeAccess.InspcSetValue accSetValue, InspcDataExchangeAccess.Inspcitem answerItem)` Gets or sets a value by given path of reflection.
`static short`	`getTypeFromField(FieldJc theField)` Converts the given Field of Reflection to the type byte.
`private short`	`getValueByHandle(int handle, InspcDataExchangeAccess.InspcAnswerValueByHandle answItem, InspcDataExchangeAccess.InspcDatagram answer, int index, int nOrderNr)` Gets a value which is registered before by `registerHandle(String, org.vishia.communication.InspcDataExchangeAccess.Inspcitem)` This is the core routine for `cmdGetValueByHandle(org.vishia.communication.InspcDataExchangeAccess.Inspcitem, org.vishia.communication.InspcDataExchangeAccess.InspcDatagram, int)` which needs writing to the answer datagram.
`int`	`registerHandle(java.lang.String sVariablePath, InspcDataExchangeAccess.Inspcitem answerItem)` Registers a path for repeated access
`void`	`setAnswerComm(AnswerComm_ifc answerComm)` sets all aggregations which are unknown on constuctor.
`void`	`setRootObject(ClassJc rootClazz, MemSegmJc rootAddr)` Sets the Object which is the root for all data.
`void`	`setRootObject(java.lang.Object rootObj)` Sets the Object which is the root for all data.
`(package private) void`	`stop()`
`private void`	`txAnswerAndPrepareNewTelg(InspcDataExchangeAccess.InspcDatagram answer)` The information doesn't fit in the datagram: Send the last one and clear it.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
static final java.lang.String version
```
    Version, history and license.
    - 2019-03-01 Hartmut some chg adequate and similar to the translated C-routines (no re-translating Java2C yet done but similar changed):
      rootClass, rootAddr instead XXXrootObj: In C it is possible to have a rootAddr outside the own code, in a target proxy. In C it is possible to have a non-Object.based instance with separate reflection info (Class).
      new setRootObject(ClassJc, MemSegmJc)
      call SearchElement.searchObject(String, ClassJc, MemSegmJc, FieldJc[], int[]) with separated class and instance reference.
    - 2016-16-28 Hartmut chg: Some changes for Java2C translation, test with InspcTargetProxy
    - 2016-16-10 Hartmut chg: ClassContent: SimpleVariableRef is faulty for Java2C in , use Stackinstance, SimpleArray.
    - 2016-01-25 Hartmut chg: refactoring getValueByHandle especially for a longer telegram. new txAnswerAndPrepareNewTelg(...), addAnswerItemValueByHandle(...), completeAnswerItemByHandle(...),
    - 2015-08-05 Hartmut new #getValueByHandle(int, org.vishia.communication.InspcDataExchangeAccess.Inspcitem) etc. to access data with path without a reflection item, directly in the same application.
    - 2015-06-02 Hartmut bugfix: evaluateFieldGetFields(org.vishia.communication.InspcDataExchangeAccess.InspcDatagram, String, ClassJc, int, int, int, int): The incrAnswerNr() was called twice because it is called on CmdExecuter.txAnswer(int, boolean) too.
    - 2015-03-28 Hartmut bugfix: The argument 'maxNrofAnswerBytes' of all cmd execution methods is not used furthermore. The current length in the answer is stored in the ByteDataAccess indices already. The algorithm to determine the length in the answer datagram with extra count is erroneously. Don't use it. TODO remove this argument.
    - 2015-01-10 Hartmut chg: Now detects a superclass, provides a Field "super" which is regarded in @link FieldJc and @link ClassJc.getSuperField().
    - 2014-11-02 Hartmut chg: evaluateFieldGetFields(org.vishia.communication.InspcDataExchangeAccess.InspcDatagram, FieldJc, int, int): Problem with answer for long structures with second telegram. TODO: test it for C too!
    - 2013-12-07 Hartmut requfix: Check of the Index for getValueByIndex: Don't start from 0, because a reseted target starts by 0 always. Use 16 bit of seconds, about 18 h. Only a new restart in exactly 65536 seconds are faulty. If the index is invalid, the InspcDataExchangeAccess.kInvalidHandle is returned for this value. The requester should remove that index. It is implemented in InspcVariable.
    - 2013-01-10 Hartmut bugfix: If the path fails in #getSetValueByPath(org.vishia.communication.InspcDataExchangeAccess.Inspcitem, org.vishia.communication.InspcDataExchangeAccess.InspcSetValue, org.vishia.communication.InspcDataExchangeAccess.InspcDatagram, String, int), It should be returned a message anyway. If nothing is returned, the calling doesn't know that problem and the whole telegram may not be sent. It would cause a timeout.
    - 2012-04-08 Hartmut new: Support of GetValueByIdent
    - 2011-02-00 Hartmut created, converted from the C implementation.
    - 2006-00-00 Hartmut created for C/C++
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - __TEST__
```
final byte[] __TEST__
```
  - XXXrootObj
```
private java.lang.Object XXXrootObj
```
    The Object from which the user-given path starts to search. See SearchElement#searchObject(String, Object, FieldJc[], int[]).
  - rootClass
```
private ClassJc rootClass
```
    The class to the rootAddr.
  - rootAddr
```
private MemSegmJc rootAddr
```
    For C usage: It can be in an extended memory area. It can be a non-Object instance.
  - answerComm
```
private AnswerComm_ifc answerComm
```
    Association to produce the answer of a request. It is possible to send more as one answer telegram.
  - debugRemoteAccess
```
public MemAccessArrayDebugJc debugRemoteAccess
```
    Yet only a placeholder, used in the C-implementation. @java2c=simpleRef.
  - answerItem
```
private final InspcDataExchangeAccess.Inspcitem answerItem
```
    Access element for ByteDataAccessBase to the answer Item. It is reused whenever an info item is to be added.
  - uArray
```
private final java.lang.StringBuilder uArray
```
    Buffer to prepare a array information in the answer of a telegram.
  - uValue
```
private final java.lang.StringBuilder uValue
```
    Buffer to prepare the value in the answer of a telegram.
  - uAnswer
```
private final java.lang.StringBuilder uAnswer
```
    Buffer to prepare the answer in the answer of a telegram.
  - test
```
final InspcDataInfo test
```
    java2c=simpleRef.
  - handles
```
final InspcDataInfo[] handles
```
    Array of registered data access info items. @java2c = embeddedArrayElements.
- Constructor Detail
  - ClassContent
```
public ClassContent()
```
- Method Detail
  - setRootObject
```
public final void setRootObject(java.lang.Object rootObj)
```
    Sets the Object which is the root for all data.
    
    Parameters:
    
    rootObj -
  - setRootObject
```
public final void setRootObject(ClassJc rootClazz,
                                MemSegmJc rootAddr)
```
    Sets the Object which is the root for all data.
    
    Parameters:
    
    rootObj -
  - setAnswerComm
```
public final void setAnswerComm(AnswerComm_ifc answerComm)
```
    sets all aggregations which are unknown on constuctor.
    
    Specified by:
    
    setAnswerComm in interface CmdConsumer_ifc
  - executeMonitorCmd
```
public int executeMonitorCmd(InspcDataExchangeAccess.Inspcitem cmd,
                             InspcDataExchangeAccess.InspcDatagram answer,
                             int maxNrofAnswerBytes)
                      throws java.lang.IllegalArgumentException,
                             java.io.UnsupportedEncodingException
```
    Description copied from interface: CmdConsumer_ifc
    
    Executes a command, writes the answer in the answer datagram.
    
    Rules vor answer:
    
    The answer-Datagram is given with prepared head. The only one value is the current datagram length which should be set to the head before it is send. But this action is done in the method AnswerComm_ifc.txAnswer(int, boolean). The user should add its InspcDataExchangeAccess.Inspcitem-elements for the answer there. Only if the datagram is full and a next info have to be add, the current datagram should be send. Therefore the routine AnswerComm_ifc.txAnswer(int, boolean) should be called with the current number of bytes and false as 2. parameter. A non-filled datagram is not to be sent. It will be send after the last invocation of a command consumer from the activator of this method. In this way more as one answer can be given in one ore more datagrams, while the command datagram may contain more as one command too.
    
    Specified by:
    
    executeMonitorCmd in interface CmdConsumer_ifc
    
    Parameters:
    
    cmd - The command. It is one information unit only, not a full datagram, because the command is containing in a information unit. A datagram may contain more as one command.
    
    answer - answer datagram with prepared head, maybe with already content. The answer information units are to be add here. The datagram is to be send, if it is full.
    
    maxNrofAnswerBytes - The maximum of bytes inclusive head in the datagram.
    
    Returns:
    
    0
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - txAnswerAndPrepareNewTelg
```
private void txAnswerAndPrepareNewTelg(InspcDataExchangeAccess.InspcDatagram answer)
```
    The information doesn't fit in the datagram: Send the last one and clear it.
  - cmdGetFields
```
private final int cmdGetFields(InspcDataExchangeAccess.Inspcitem cmd,
                               InspcDataExchangeAccess.InspcDatagram answer,
                               int maxNrofAnswerBytes)
```
  - evaluateFieldGetFields
```
private final void evaluateFieldGetFields(InspcDataExchangeAccess.InspcDatagram answer,
                                          FieldJc field,
                                          int orderNr,
                                          int maxNrofAnswerBytes)
```
  - evaluateFieldGetFields
```
private final void evaluateFieldGetFields(InspcDataExchangeAccess.InspcDatagram answer,
                                          java.lang.String name,
                                          ClassJc typeField,
                                          int modifiers,
                                          int staticArraySize,
                                          int orderNr,
                                          int maxNrofAnswerBytes)
```
  - cmdGetValueByPath
```
private final int cmdGetValueByPath(InspcDataExchangeAccess.Inspcitem cmd,
                                    InspcDataExchangeAccess.InspcDatagram answer)
                             throws java.lang.IllegalArgumentException,
                                    java.io.UnsupportedEncodingException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - cmdSetValueByPath
```
private final int cmdSetValueByPath(InspcDataExchangeAccess.Inspcitem cmd,
                                    InspcDataExchangeAccess.InspcDatagram answer)
                             throws java.lang.IllegalArgumentException,
                                    java.io.UnsupportedEncodingException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - getSetValueByPath
```
public final void getSetValueByPath(int nOrderNr,
                                    java.lang.String sVariablePath,
                                    InspcDataExchangeAccess.InspcSetValue accSetValue,
                                    InspcDataExchangeAccess.Inspcitem answerItem)
                             throws java.lang.IllegalArgumentException,
                                    java.io.UnsupportedEncodingException
```
    Gets or sets a value by given path of reflection. Combination of get and set value by path. Both requests answers the current value. Therefore the functionality is similar.
    
    Parameters:
    
    nOrderNr - The order number for answer.
    
    sVariablePath - variable-path like it is found in cmd
    
    accSetValue - if null then get, if not null, the value to set, It refers inside the request for the set value.
    
    answerItem - response datagram item for answer. The item should be added already to a parent if necessary.
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - getSetValue
```
private static short getSetValue(FieldJc theField,
                                 int idx,
                                 MemSegmJc theObject,
                                 InspcDataExchangeAccess.InspcSetValue accSetValue,
                                 InspcDataExchangeAccess.Inspcitem answerItem,
                                 boolean bStoreTypeInAnswer)
                          throws java.lang.IllegalArgumentException,
                                 java.lang.IllegalAccessException
```
    Sets the value if accSetValue is not null, fills the answerItem with the read value. Fills with or without type byte.
    
    Parameters:
    
    theField - describes the field to access
    
    idx - with this index
    
    theObject - in this object
    
    accSetValue - null or given to set a value.
    
    answerItem - It writes the type with one byte if bStoreTypeInAnswer = true, and than the value with ByteDataAccessBase#addChildInteger(int, long) or such with the read value.
    
    bStoreTypeInAnswer - true then stores the 1-byte-type information before the value. false then store the value only.
    
    Returns:
    
    the type of the field if this information has space in the current telegram. -1 If there are no space.
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - cmdGetAddressByPath
```
private final int cmdGetAddressByPath(InspcDataExchangeAccess.Inspcitem cmd,
                                      InspcDataExchangeAccess.InspcDatagram answer,
                                      int maxNrofAnswerBytes)
                               throws java.lang.IllegalArgumentException,
                                      java.io.UnsupportedEncodingException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - cmdRegisterRepeat
```
int cmdRegisterRepeat(InspcDataExchangeAccess.Inspcitem cmd,
                      InspcDataExchangeAccess.InspcDatagram answer,
                      int maxNrofAnswerBytes)
               throws java.lang.IllegalArgumentException,
                      java.io.UnsupportedEncodingException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - registerHandle
```
public int registerHandle(java.lang.String sVariablePath,
                          InspcDataExchangeAccess.Inspcitem answerItem)
                   throws java.lang.IllegalArgumentException
```
    Registers a path for repeated access
    
    Parameters:
    
    sVariablePath -
    
    answerItem - maybe null then not used, elsewhere the current value is added.
    
    Returns:
    
    -1 on failure, ident if success.
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - addAnswerItemValueByHandle
```
private void addAnswerItemValueByHandle(InspcDataExchangeAccess.InspcDatagram answer,
                                        InspcDataExchangeAccess.InspcAnswerValueByHandle answItem,
                                        int sizeExpected)
```
  - completeAnswerItemByHandle
```
private void completeAnswerItemByHandle(InspcDataExchangeAccess.InspcAnswerValueByHandle answItem,
                                        int indexTo,
                                        int nOrderNr)
```
  - cmdGetValueByHandle
```
int cmdGetValueByHandle(InspcDataExchangeAccess.Inspcitem cmd,
                        InspcDataExchangeAccess.InspcDatagram answer,
                        int maxNrofAnswerBytes)
                 throws java.lang.IllegalArgumentException,
                        java.io.UnsupportedEncodingException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.io.UnsupportedEncodingException
  - getValueByHandle
```
private short getValueByHandle(int handle,
                               InspcDataExchangeAccess.InspcAnswerValueByHandle answItem,
                               InspcDataExchangeAccess.InspcDatagram answer,
                               int index,
                               int nOrderNr)
```
    Gets a value which is registered before by registerHandle(String, org.vishia.communication.InspcDataExchangeAccess.Inspcitem) This is the core routine for cmdGetValueByHandle(org.vishia.communication.InspcDataExchangeAccess.Inspcitem, org.vishia.communication.InspcDataExchangeAccess.InspcDatagram, int) which needs writing to the answer datagram. If this routine is used directly, inside this target, this routine can be used with following pattern:
```
    byte[] answerBuffer = new byte[20]; //buffer for the answer
        InspcDataExchangeAccess.Inspcitem answItem = new InspcDataExchangeAccess.Inspcitem();
        answItem.assignClear(answerBuffer);
        short type = inspector.classContent.getValueByHandle(handle, answItem);
        //The result is written to the answerBuffer, the answItem is the helper only.
        answItem.assign(answerBuffer); //assign newly but yet to read the content.
        int value = InspcDataExchangeAccess.getIntChild(type, answItem);
 
```
    See getFloatValueByHandle(int), getIntValueByHandle(int) which uses this routine.
    Parameters:
    
    handle - The returned ident from registration
    
    answItem - destination jar for the value. The bytes of value will be appended as child only. The number of bytes are able to evaluate by checking the length of the item respectively the InspcDataExchangeAccess.nrofBytesForType(short) with the returned type. That information was stored also by executing of registerHandle(String, org.vishia.communication.InspcDataExchangeAccess.Inspcitem) in the target system too. Therefore the number of the bytes of the value and the type of value should be known, it is not transferred in the datagram.
    
    Returns:
    
    The type of value or InspcDataExchangeAccess#kInvalidHandle
  - getFloatValueByHandle
```
public float getFloatValueByHandle(int handle)
```
    Gets the value described by this handle as float value. This method is offered to get a value by an internal access via reflection.
    
    Parameters:
    
    handle - Return value of registerHandle(String, org.vishia.communication.InspcDataExchangeAccess.Inspcitem)
    
    Returns:
    
    The float value or 0 on error.
  - getIntValueByHandle
```
public int getIntValueByHandle(int handle)
```
    Gets the value described by this handle as int32 value. This method is offered to get a value by an internal access via reflection.
    
    Parameters:
    
    handle - Return value of registerHandle(String, org.vishia.communication.InspcDataExchangeAccess.Inspcitem)
    
    Returns:
    
    The int value or 0 on error.
  - getTypeFromField
```
public static short getTypeFromField(FieldJc theField)
```
    Converts the given Field of Reflection to the type byte.
    
    Parameters:
    
    theField - describes the field to access
    
    idx - with this index
    
    Returns:
    
    the type of the field if this information has space in the current telegram. -1 If there are no space.
  - stop
```
final void stop()
```

Class ClassContent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

__TEST__

XXXrootObj

rootClass

rootAddr

answerComm

debugRemoteAccess

answerItem

uArray

uValue

uAnswer

test

handles

Constructor Detail

ClassContent

Method Detail

setRootObject

setRootObject

setAnswerComm

executeMonitorCmd

txAnswerAndPrepareNewTelg

cmdGetFields

evaluateFieldGetFields

evaluateFieldGetFields

cmdGetValueByPath

cmdSetValueByPath

getSetValueByPath

getSetValue

cmdGetAddressByPath

cmdRegisterRepeat

registerHandle

addAnswerItemValueByHandle

completeAnswerItemByHandle

cmdGetValueByHandle

getValueByHandle

getFloatValueByHandle

getIntValueByHandle

getTypeFromField

stop

TEST