FieldJc

java.lang.Object
- org.vishia.reflect.FieldJc

```
public class FieldJc
extends java.lang.Object
```
This class extends the capability of the Java standard class java/lang/reflect/Field. There are some intension to do so. The most important is the compatibility to reflections in C Language:

The C language provides a more width variation of referencing and array addressing. In the C-reflection, the access to array elements is part of the FieldJc-methods. All get/setType-methods get an index or more as one index to address an array. So the get/set is executed in the reflection shell. In opposite in Java some operations are need to detect the type, size and dimension of an array to set elements.

A second approach is the access to a external hardware used especially at C-level. The reflection information for the second hardware may be contained in a host environment, in C. There the reflection processing is executed. The real hardware is attached only with simple questions for root instance, type idents, memory content. They are simple 4-byte-accesses which can be done via a small port for example a Dual-Port-RAM oder CAN-Bus-communication or via Ethernet too. At the real target (second) hardware only some arrays with offsets and types in integer-format are need, and simple algorithm.

A further approach for C-reflection is working without Object-based structures.

Another approach is providing reflection information in Java for non-Java platforms. The reflection information are generated from C-header and provides as byte-image. That information can be used
- In Java to access data which are given as byte-image form a C-platform.
- For access to another hardware (second CPU).
It is adequate the functionality of the CRuntimeJavalike-class FieldJc, but for Java application. The following enhancements in comparison with java.lang.reflect.Field are done:
- The general strategy to give any instance is: Supply the instance in form of a MemSegmJc-reference instead of a java.lang.Object-reference. There are two reasons:
  - In the C-implementation, non-Object-base structures are supported too. An ObjectJc*-pointer can't be used in all cases.
  - To support access to an external hardware, an additional information (segment) is necessary always proper to the instance reference.
  The type MemSegmJc is deployed in C with a segment information and a void*-pointer, where in Java it is a Object-reference for normal reflection usage, the segment information and an int-address for access to extern memory with special Interprocesscomm-Mechanism such as UDP-Telegrams, serial data transmission or access via JNI.
- All get and set-Methods to access field contents have an int... Argument for indexing an array.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`FieldJc.GetArray<ArrayType>` Helper class containing a template method to get the last array and the last index for indexed access.
`(package private) class`	`FieldJc.GetSetContainerElement<ElementType,ArrayType>` Helper class containing a template method to get and set a value in an array or container for indexed access.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static java.lang.Class<Java4C.FixArraySize>`	`annotationJava2CFixArraySize` That annotation is used to detect fix-size-arrays.
`(package private) java.lang.annotation.Annotation[]`	`annotations` All annotations from `field`.
`private FieldJc.GetSetContainerElement<java.lang.Character,char[]>`	`charContainer` Helper contains the method to access an int[]-array.
`(package private) char`	`cPrimitveType`
`private FieldJc.GetSetContainerElement<java.lang.Double,double[]>`	`doubleContainer` Helper contains the method to access an float[]-array.
`private java.lang.reflect.Field`	`field` Aggregation to the original field of reflection from Java.
`private FieldJc.GetSetContainerElement<java.lang.Float,float[]>`	`floatContainer` Helper contains the method to access an float[]-array.
`private FieldJc.GetArray<byte[]>`	`getByteArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<double[]>`	`getDoubleArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<float[]>`	`getFloatArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<long[]>`	`getLongArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<java.lang.Object[]>`	`getObjectArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<short[]>`	`getShortArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetArray<java.lang.String[]>`	`getStringArray` Helper contains the method to access an int[]-array.
`private FieldJc.GetSetContainerElement<java.lang.Integer,int[]>`	`intContainer` Helper contains the method to access an int[]-array.
`private FieldJc.GetSetContainerElement<java.lang.Long,long[]>`	`longContainer` Helper contains the method to access an int[]-array.
`private int`	`modifier` The modifier contains some more informations as java.reflect.field.
`private java.lang.String`	`name` Name of the field.
`private FieldJc.GetSetContainerElement<java.lang.Short,short[]>`	`shortContainer` Helper contains the method to access an int[]-array.
`(package private) int[]`	`staticArraySize` The size of a static array.
`ClassJc`	`type` The type of the field.
`static int`	`version` Version, history and license.

Constructor Summary

Constructors
Constructor and Description
`FieldJc(ClassJc clazz, java.lang.String name)`
`FieldJc(java.lang.Class clazz, java.lang.String name)`
`FieldJc(java.lang.reflect.Field field)` Creates based on a given field.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MemSegmJc`	`get(MemSegmJc obj, int... ix)`
`int`	`getArraylength(MemSegmJc instance)`
`(package private) int`	`getArraylengthUML_ArrayList(MemSegmJc instance)`
`(package private) int`	`getArraylengthUML_LinkedList(MemSegmJc instance)`
`(package private) int`	`getArraylengthUML_Map(MemSegmJc instance)`
`short`	`getBitfield(MemSegmJc obj, int... ix)` Gets the value from a bitField.
`boolean`	`getBoolean(MemSegmJc obj, int... ix)`
`byte`	`getByte(MemSegmJc obj, int... ix)`
`char`	`getChar(MemSegmJc obj, int... ix)`
`MemSegmJc`	`getContainer(MemSegmJc obj, int... ix)`
`double`	`getDouble(MemSegmJc obj, int... ix)`
`float`	`getFloat(MemSegmJc obj, int... ix)`
`int`	`getInt(MemSegmJc obj, int... ix)`
`long`	`getInt64(MemSegmJc obj, int... ix)`
`(package private) int`	`getLength(java.lang.Object objArray)`
`long`	`getLong(MemSegmJc obj, int... ix)`
`int`	`getMemoryIdent(MemSegmJc obj, int... ix)`
`int`	`getModifiers()`
`java.lang.String`	`getName()`
`MemSegmJc`	`getObjAndClass(MemSegmJc instanceM, ClassJc[] retClazz, int... idx)` Returns the real Class and the referenced Object appropriate to the field in the given Object.
`short`	`getShort(MemSegmJc obj, int... ix)`
`int`	`getStaticArraySize()`
`java.lang.String`	`getString(MemSegmJc instance, int... ix)` Gets a String representation of the content of this FieldJc in the given instance.
`ClassJc`	`getType()`
`char`	`getTypeChar()` Returns the type char.
`short`	`setBitfield(MemSegmJc obj, short value, int... ix)` Gets the value from a bitField.
`boolean`	`setBoolean(MemSegmJc objM, boolean val, int... ix)` Sets the integer adequate Field.setInt(obj, value), but with one or more indices.
`char`	`setChar(MemSegmJc objM, char valSet, int... ix)`
`double`	`setDouble(MemSegmJc objM, double valSet, int... ix)`
`float`	`setFloat(MemSegmJc objM, float valSet, int... ix)`
`int`	`setInt(MemSegmJc objM, int valSet, int... ix)`
`int`	`setShort(MemSegmJc objM, short valSet, int... ix)`
`java.lang.String`	`toString()`
`int`	`xxxgetInt(MemSegmJc obj, int... ix)`

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

- Field Detail
  - version
```
public static final int version
```
    Version, history and license.
    - 2018-10-19 Hartmut ctor: '[L' is an Object[]. Use fieldType.getComponentType() for reference type. getObjAndClass(MemSegmJc, ClassJc[], int...): correct access to an Object[] with given ix.
    - 2012-08-23 Hartmut getFloat(MemSegmJc, int...) now supports non-static arrays too. Experience.
    - 2008-00-00 Hartmut created
    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 doesn'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 intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - annotationJava2CFixArraySize
```
static final java.lang.Class<Java4C.FixArraySize> annotationJava2CFixArraySize
```
    That annotation is used to detect fix-size-arrays. In Java all arrays are dynamically, but to test the reflection access in Java adequate to C static arrays should be emulated.
  - field
```
private final java.lang.reflect.Field field
```
    Aggregation to the original field of reflection from Java. It may be null if the reflections don't come from Java.
  - name
```
private final java.lang.String name
```
    Name of the field. It is the same like field.getName(), but set if field == null.
  - type
```
public final ClassJc type
```
    The type of the field.
  - cPrimitveType
```
final char cPrimitveType
```
  - modifier
```
private int modifier
```
    The modifier contains some more informations as java.reflect.field. It is copied from field, some more bits are added, see ModifierJc.
  - staticArraySize
```
final int[] staticArraySize
```
    The size of a static array. Note: The array size may be changed in Java. Only a final array isn't changed. If null then it isn't an array.
  - annotations
```
final java.lang.annotation.Annotation[] annotations
```
    All annotations from field.
  - intContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Integer,int[]> intContainer
```
    Helper contains the method to access an int[]-array.
  - longContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Long,long[]> longContainer
```
    Helper contains the method to access an int[]-array.
  - shortContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Short,short[]> shortContainer
```
    Helper contains the method to access an int[]-array.
  - floatContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Float,float[]> floatContainer
```
    Helper contains the method to access an float[]-array.
  - doubleContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Double,double[]> doubleContainer
```
    Helper contains the method to access an float[]-array.
  - charContainer
```
private final FieldJc.GetSetContainerElement<java.lang.Character,char[]> charContainer
```
    Helper contains the method to access an int[]-array.
  - getShortArray
```
private final FieldJc.GetArray<short[]> getShortArray
```
    Helper contains the method to access an int[]-array.
  - getByteArray
```
private final FieldJc.GetArray<byte[]> getByteArray
```
    Helper contains the method to access an int[]-array.
  - getLongArray
```
private final FieldJc.GetArray<long[]> getLongArray
```
    Helper contains the method to access an int[]-array.
  - getFloatArray
```
private final FieldJc.GetArray<float[]> getFloatArray
```
    Helper contains the method to access an int[]-array.
  - getDoubleArray
```
private final FieldJc.GetArray<double[]> getDoubleArray
```
    Helper contains the method to access an int[]-array.
  - getObjectArray
```
private final FieldJc.GetArray<java.lang.Object[]> getObjectArray
```
    Helper contains the method to access an int[]-array.
  - getStringArray
```
private final FieldJc.GetArray<java.lang.String[]> getStringArray
```
    Helper contains the method to access an int[]-array.
- Constructor Detail
  - FieldJc
```
public FieldJc(java.lang.reflect.Field field)
```
    Creates based on a given field.
    
    Parameters:
    
    field - Any field of reflection.
  - FieldJc
```
public FieldJc(java.lang.Class clazz,
               java.lang.String name)
```
  - FieldJc
```
public FieldJc(ClassJc clazz,
               java.lang.String name)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
  - getType
```
public ClassJc getType()
```
  - getTypeChar
```
public char getTypeChar()
```
    Returns the type char. For primitives it is B S I L F D Z C, for non-primitives it returns 0.
    
    Returns:
    
    0 if non primitive, else typechar.
  - getModifiers
```
public int getModifiers()
```
  - getStaticArraySize
```
public int getStaticArraySize()
```
  - getArraylength
```
public int getArraylength(MemSegmJc instance)
                   throws java.lang.IllegalArgumentException,
                          java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getLength
```
int getLength(java.lang.Object objArray)
```
  - getObjAndClass
```
public MemSegmJc getObjAndClass(MemSegmJc instanceM,
                                ClassJc[] retClazz,
                                int... idx)
```
    Returns the real Class and the referenced Object appropriate to the field in the given Object. The field should be a reference field, not a primitive. It means, this.getType().isPrimitive() should return false.
    If
    Elsewhere, for ordinary fields, the retClazz is the
    
    Parameters:
    
    instanceM - The reference to the Object, where the field is located in. It may be located in a extern hardware.
    
    retClazz - The really type of retObj, not only the this.getType(). The really type is gotten from the referenced Object of that field. Only if this field is a special FieldJc instance to access the super data, it's name is "super", then this operation returns instanceM itself and set retClazz to the ClassJc type of the superclass. With them the reflection Access for Inspc presents the fields of the superclass as tree.
    
    idx - Given index if the field is an array-field.
    
    Returns:
    
    The object which is referenced. It may be null contain a null-reference. The referenced object may be located in a extern hardware, though instanceM is locally. A special reference is responsible to referencing a external hardware.
  - getByte
```
public byte getByte(MemSegmJc obj,
                    int... ix)
             throws java.lang.IllegalArgumentException,
                    java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getShort
```
public short getShort(MemSegmJc obj,
                      int... ix)
               throws java.lang.IllegalArgumentException,
                      java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setShort
```
public int setShort(MemSegmJc objM,
                    short valSet,
                    int... ix)
             throws java.lang.IllegalArgumentException,
                    java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - xxxgetInt
```
public int xxxgetInt(MemSegmJc obj,
                     int... ix)
              throws java.lang.IllegalArgumentException,
                     java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getInt
```
public int getInt(MemSegmJc obj,
                  int... ix)
           throws java.lang.IllegalArgumentException,
                  java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getLong
```
public long getLong(MemSegmJc obj,
                    int... ix)
             throws java.lang.IllegalArgumentException,
                    java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setInt
```
public int setInt(MemSegmJc objM,
                  int valSet,
                  int... ix)
           throws java.lang.IllegalArgumentException,
                  java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getChar
```
public char getChar(MemSegmJc obj,
                    int... ix)
             throws java.lang.IllegalArgumentException,
                    java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setChar
```
public char setChar(MemSegmJc objM,
                    char valSet,
                    int... ix)
             throws java.lang.IllegalArgumentException,
                    java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getInt64
```
public long getInt64(MemSegmJc obj,
                     int... ix)
              throws java.lang.IllegalArgumentException,
                     java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getFloat
```
public float getFloat(MemSegmJc obj,
                      int... ix)
               throws java.lang.IllegalArgumentException,
                      java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setFloat
```
public float setFloat(MemSegmJc objM,
                      float valSet,
                      int... ix)
               throws java.lang.IllegalArgumentException,
                      java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getDouble
```
public double getDouble(MemSegmJc obj,
                        int... ix)
                 throws java.lang.IllegalArgumentException,
                        java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setDouble
```
public double setDouble(MemSegmJc objM,
                        double valSet,
                        int... ix)
                 throws java.lang.IllegalArgumentException,
                        java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getBoolean
```
public boolean getBoolean(MemSegmJc obj,
                          int... ix)
                   throws java.lang.IllegalArgumentException,
                          java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getBitfield
```
public short getBitfield(MemSegmJc obj,
                         int... ix)
                  throws java.lang.IllegalArgumentException,
                         java.lang.IllegalAccessException
```
    Gets the value from a bitField. A bitField is deployed in C/C++ only. In Java it may be possible to get a value from a bitField from a extern C-programmed module (TODO).
    
    Parameters:
    
    obj -
    
    ix -
    
    Returns:
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setBitfield
```
public short setBitfield(MemSegmJc obj,
                         short value,
                         int... ix)
                  throws java.lang.IllegalArgumentException,
                         java.lang.IllegalAccessException
```
    Gets the value from a bitField. A bitField is deployed in C/C++ only. In Java it may be possible to get a value from a bitField from a extern C-programmed module (TODO).
    
    Parameters:
    
    obj -
    
    ix -
    
    Returns:
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getString
```
public java.lang.String getString(MemSegmJc instance,
                                  int... ix)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IllegalAccessException
```
    Gets a String representation of the content of this FieldJc in the given instance.
    - If the field is a Object-compatible type (a reference) and the reference is not null, then the Object.toString()-method is invoked with this reference.
    - If the reference is null, than "null" is returned.
    - If the field is a primitive type, the String representation of its content is returned.
    - For C-usage: If the field references a non-Object-instance, "@addr" is returned, where addr is the memory address of the referenced instance (the reference value).
    Parameters:
    
    instance - The instance where this FieldJc is member of.
    
    ix - 0 or more indices if the Field is an array or container.
    
    Returns:
    
    A String which represents the content of the field.
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - get
```
public MemSegmJc get(MemSegmJc obj,
                     int... ix)
              throws java.lang.IllegalArgumentException,
                     java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - getMemoryIdent
```
public int getMemoryIdent(MemSegmJc obj,
                          int... ix)
```
  - getContainer
```
public MemSegmJc getContainer(MemSegmJc obj,
                              int... ix)
                       throws java.lang.IllegalArgumentException,
                              java.lang.IllegalAccessException
```
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.lang.IllegalAccessException
  - setBoolean
```
public boolean setBoolean(MemSegmJc objM,
                          boolean val,
                          int... ix)
                   throws java.lang.IllegalArgumentException,
                          java.lang.IllegalAccessException
```
    Sets the integer adequate Field.setInt(obj, value), but with one or more indices.
    
    Parameters:
    
    data -
    
    val -
    
    ix -
    
    Throws:
    
    java.lang.IllegalAccessException
    
    java.lang.IllegalArgumentException
  - getArraylengthUML_LinkedList
```
int getArraylengthUML_LinkedList(MemSegmJc instance)
```
  - getArraylengthUML_ArrayList
```
int getArraylengthUML_ArrayList(MemSegmJc instance)
```
  - getArraylengthUML_Map
```
int getArraylengthUML_Map(MemSegmJc instance)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FieldJc

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

annotationJava2CFixArraySize

field

name

type

cPrimitveType

modifier

staticArraySize

annotations

intContainer

longContainer

shortContainer

floatContainer

doubleContainer

charContainer

getShortArray

getByteArray

getLongArray

getFloatArray

getDoubleArray

getObjectArray

getStringArray

Constructor Detail

FieldJc

FieldJc

FieldJc

Method Detail

getName

getType

getTypeChar

getModifiers

getStaticArraySize

getArraylength

getLength

getObjAndClass

getByte

getShort

setShort

xxxgetInt

getInt

getLong

setInt

getChar

setChar

getInt64

getFloat

setFloat

getDouble

setDouble

getBoolean

getBitfield

setBitfield

getString

get

getMemoryIdent

getContainer

setBoolean

getArraylengthUML_LinkedList

getArraylengthUML_ArrayList

getArraylengthUML_Map

toString