17.4Metadaten der Typen mit dem Class-Objekt
Ein Class-Objekt beschreibt eine Reihe von Eigenschaften, wie Namen, Beziehungen, Annotationen, die sich mit unterschiedlichen Methoden erfragen lassen.
17.4.1Der Name des Typs
Liegt zu einem Typ das Class-Objekt vor, so können wir zur Laufzeit ihren voll qualifizierten Namen über die Methode getName() ausgeben. Da jeder Typ über einen Namen verfügt, führt diese Methode also jedes Mal zum Ziel:
Anweisung | String-Rückgabe |
---|---|
java.util.Date().getClass().getName() | java.util.Date |
java.util.RandomAccess.class.getName() | java.util.RandomAccess |
Deprecated.class.getName() | java.lang.Deprecated |
Thread.State.class.getName() | java.lang.Thread$State |
Tabelle 17.2getName() liefert eine String-Repräsentation diverser Typen
Während getName() den voll qualifizierten Namen liefert, liefert getSimple() nur den Typnamen und keine Paketangabe.
toString(), toGenericString(), getCanonicalName()
Die Klasse Class überschreibt die Methode toString() und greift dabei auf getName() zurück. toString() fügt zusätzlich Informationen über die Art des repräsentierten Typs (normale Klasse, Schnittstelle oder primitiver Datentyp) ein. Neu in Java 8 ist toGenericString(), was auch noch in spitzen Klammern die Typvariablen anzeigt (natürlich nicht den Typparameter, da der zur Laufzeit wegen der Typlöschung nicht bekannt ist). Um die Typvariable zu erfragen, wird (ab Java 8) getTypeName() verwendet; die Methode ist eine Implementierung aus der Schnittstelle Type, die Class implementiert.
[zB]Beispiel
Teste für ein Class-Objekt die vier String-Repräsentationen:
System.out.println( c.getName() ); // java.util.HashMap
System.out.println( c.getSimpleName() ); // HashMap
System.out.println( c.toString() ); // class java.util.HashMap
System.out.println( c.toGenericString() ); // public class java.util.HashMap<K,V>
Bei inneren Typen trennt ein $ bei der String-Repräsentation den äußeren und inneren Typ. Anders verhält sich getCanonicalName(), wie das Beispiel zeigt:
Anweisung | Rückgabe |
---|---|
Map.Entry.class.getName() | java.util.Map$Entry |
Map.Entry.class.getCanonicalName() | java.util.Map.Entry |
Map.Entry.class.toString() | interface java.util.Map$Entry |
Map.Entry.class.toGenericString() | public abstract static interface java.util.Map$Entry<K,V> |
Tabelle 17.3String-Repräsentation bei inneren Typen
Kodierung von Feldern *
Schwieriger ist die Kodierung bei Array-Typen, die ja eine besondere Form von Klassen sind. getName() kodiert sie mit einer führenden »[«. Jede Klammer steht dabei für eine Dimension des Array-Typs. Nach den Klammern folgt in einer kodierten Form der Typ der Array-Elemente. So liefert
System.out.println( (new int[2][3][4]).getClass().getName() ); // [[[I
den String »[[[I«, also einen dreidimensionalen Array-Typ mit Array-Elementen vom primitiven Typ int. Der Elementtyp ist wie folgt kodiert:
Kürzel | Datentyp |
---|---|
B | Byte |
C | Char |
D | Double |
F | Float |
I | Int |
J | Long |
LElementtyp; | Klasse oder Schnittstelle |
S | Short |
Z | Boolean |
Tabelle 17.4Kodierung der Elementtypen
Nimmt das Array Objektreferenzen auf, wird deren Typ in der Form »LKlassenname;« kodiert. So liefert (new Object[3]).getClass().getName() den String [Ljava.lang.Object;. Der Klassen- bzw. Schnittstellenname ist wie üblich voll qualifiziert.
Der String ist auch für Class.forName(…) von Bedeutung. Im Fall von Arrays liefert die Methode ein Class-Objekt für den Elementtyp. Die ersten Versuche, ein Class-Objekt für Felder zu beziehen, scheitern an einer ClassNotFoundException:
Class.forName( "java.lang.String[]" );
In der ersten Anweisung ist der Klassenname nicht voll qualifiziert, und auch in der zweiten Anweisung ist der String falsch aufgebaut.
Steht die Frage an, ob ein Class-Objekt für ein Feld von Objekten steht oder für ein primitives Feld, lässt sich das Ergebnis von getName() auswerten:
if ( clazz != null && clazz.isArray() )
return clazz.getName().startsWith( "[L" );
return false;
}
So liefert:
System.out.println( isObjectArray( int[].class ) ); // false
System.out.println( isObjectArray( Object.class ) ); // false
implements Serializable, GenericDeclaration, Type, AnnotatedElement
String getName()
Liefert für ein Class-Exemplar als String den voll qualifizierten Namen der repräsentierten Klasse oder Schnittstelle bzw. des repräsentierten Array-Typs oder des primitiven Datentyps.String toString()
Liefert eine für Menschen lesbare String-Repräsentation des Class-Objekts.
17.4.2Was das Class-Objekt beschreibt *
Ein Class-Exemplar kann eine Schnittstelle, eine Klasse, einen primitiven Datentyp oder auch einen Array-Typ beschreiben. Dies lässt sich durch die drei Class-Methoden isInterface(), isPrimitive() und isArray() herausfinden. Wenn keine der drei Methoden für ein Class-Exemplar true liefert, repräsentiert das Objekt eine gewöhnliche Klasse.
Dass es auch Class-Exemplare gibt, die die primitiven Datentypen von Java beschreiben, erstaunt zunächst. Damit ist es jedoch möglich, die Parameter- und Ergebnistypen beliebiger Java-Methoden einheitlich durch Class-Exemplare zu beschreiben. Dazu kodiert jede der acht Wrapper-Klassen, die zu den Datentypen boolean, byte, char, short, int, long, float und double gehören, eine Konstante TYPE. Zusätzlich gib es eine spezielle Klasse Void für den »Typ« void mit genau einer Konstanten TYPE. Benötigen wir ein Class-Objekt für den primitiven Typ int, so greifen wir mit Integer.TYPE (oder alternativ mit int.class) darauf zu. Alle Class-Exemplare für primitive Datentypen werden automatisch von der JVM erzeugt. Die Methode isPrimitive() gibt genau für diese neun besonderen Class-Exemplare true zurück, sodass sie von Repräsentanten für echte Klassen unterschieden werden können.
[»]Hinweis
Obwohl void kein Typ ist, meldet isPrimitive() dies:
Das folgende Programmstück testet die Attribute von Class-Objekten systematisch durch. Wir benutzen die Class-Methode getName(), um den Namen des Class-Objekts auszugeben. Im nächsten Abschnitt mehr dazu. Das Class-Objekt für Felder setzt sich aus dem Basistyp und Paaren von eckigen Klammern zusammen, etwa double[][].class.
Listing 17.4com/tutego/insel/meta/CheckClassType.java, CheckClassType
public static void main( String[] args ) {
checkClassType( Observer.class );
checkClassType( Observable.class );
checkClassType( (new int[2][3][4]).getClass() );
checkClassType( Integer.TYPE );
}
static void checkClassType( Class<?> c ) {
if ( c.isArray() )
System.out.println( c.getName() + " ist ein Feld." );
else if ( c.isPrimitive() )
System.out.println( c + " ist ein primitiver Typ.");
else if ( c.isInterface() )
System.out.println( c.getName() + " ist ein Interface." );
else
System.out.println( c.getName() + " ist eine Klasse." );
}
}
Die Ausgabe des Programms ist nun:
java.util.Observable ist eine Klasse.
[[[I ist ein Feld.
int ist ein primitiver Typ.
implements Serializable, GenericDeclaration, Type, AnnotatedElement
boolean isInterface()
Liefert true, wenn das Class-Objekt eine Schnittstelle beschreibt.boolean isArray()
Liefert true, wenn das Class-Objekt einen Array-Typ beschreibt.boolean isPrimitive()
Testet, ob das Class-Objekt einen primitiven Datentyp beschreibt.
Komponententyp bei Feldern
Die Methode getComponentType() liefert bei Feldern den Typ der Elemente als Class-Objekt. Steht das Class-Objekt für kein Feld, ist die Methodenrückgabe null:
System.out.println( double[][].class.getComponentType() ); // class [D
System.out.println( double.class.getComponentType() ); // null
17.4.3instanceof mit Class-Objekten *
Der binäre Operator instanceof testet, ob ein Objekt Exemplar einer Klasse oder der Oberklasse ist. Wenn das Ergebnis wahr ist, lässt sich das Objekt unter dem gegebenen Typ ansprechen, ist also zuweisungskompatibel. Der rechte Operator bei instanceof, der Typname, muss jedoch immer zur Übersetzungszeit bekannt sein und kann nicht dynamisch, etwa durch einen String, festgelegt werden.
Ist der Typname zur Compilezeit vielleicht unbekannt, kann das Class-Objekt helfen. Die Methode isInstance(Object) ist sozusagen ein dynamisches instanceof. Gilt mit dem Operator
so heißt das mit der Methode:
Gewöhnungsbedürftig ist sicherlich die Tatsache, dass bei der Class-Methode isInstance(Object) die beiden Operanden umgedreht sind. Dazu ein paar Beispiele:
Listing 17.5com/tutego/insel/meta/IsAssignableFrom.java, main()
out.println( b instanceof JLabel ); // true
out.println( JLabel.class.isInstance( b ) ); // true
out.println( Object.class.isInstance( b ) ); // true
out.println( Class.forName("java.awt.Component").isInstance( b ) ); // true
out.println( String.class.isInstance( b ) ); // false
Die Methode isInstance(object) ist natürlich ein wenig dadurch eingeschränkt, dass es immer ein Test-Objekt geben muss. Die Frage etwa, ob das Class-Objekt der Schnittstelle PublicKey eine »Ist-eine-Art-von-Serializable« ist, kann isInstance(object) nicht beantworten, denn dann müsste es vorher ein Objekt geben. Für diesen Fall bietet das Class-Objekt noch eine zweite Methode, isAssignableFrom(Class):
out.println( clazz.isAssignableFrom( String.class ) ); // true
out.println( clazz.isAssignableFrom( Thread.class ) ); // false
out.println( clazz.isAssignableFrom( PublicKey.class ) ); // true
Solange der Typname zur Übersetzungszeit bekannt ist, ist instanceof immer noch die beste Lösung. Doch wenn die Klasse nur durch ein Class-Objekt gegeben ist, bleibt immer noch isAssignableFrom(Class<?> cls). Die Methode clazz.isInstance(obj) ist sozusagen eine Kurzform von clazz.isAssignableFrom(obj.getClass()).
17.4.4Oberklassen finden *
Das Class-Exemplar für eine Klasse gibt Zugriff auf die Oberklasse, die Sichtbarkeitsstufe und weitere Informationen. Die Oberklasse ermittelt getSuperclass(). Die Methode gibt null zurück, falls das Class-Objekt eine Schnittstelle repräsentiert oder wir schon am oberen Ende der Hierarchie sind, also bei dem Class-Objekt für die Wurzelklasse Object. Das folgende Programm findet alle Oberklassen einer Klasse durch den wiederholten Aufruf der Methode getSuperclass():
Listing 17.6com/tutego/insel/meta/ShowSuperclasses.java
Class<?> superclass = subclass.getSuperclass();
while ( superclass != null ) {
String className = superclass.getName();
System.out.println( className );
subclass = superclass;
superclass = subclass.getSuperclass();
}
Wahrscheinlich wäre eine rekursive Variante noch eleganter, aber darauf kommt es jetzt nicht an.
javax.swing.JComponent
java.awt.Container
java.awt.Component
java.lang.Object
implements Serializable, GenericDeclaration, Type, AnnotatedElement
Class<? super T> getSuperclass()
Liefert ein Class-Exemplar für die Oberklasse der Klasse, die durch das aufrufende Class-Objekt repräsentiert wird. Falls wir schon oben auf der Vererbungshierarchie bei Object sind oder nach der Oberklasse einer Schnittstelle fragen, liefert die Methode null.
17.4.5Implementierte Interfaces einer Klasse oder eines Interfaces *
Klassen stehen zum einen in einer Vererbungsbeziehung zu einer Oberklasse und können zum anderen mehrere Schnittstellen implementieren. Schnittstellen können ihrerseits wiederum andere Schnittstellen erweitern. Bei einer Klassendeklaration folgt direkt hinter dem Schlüsselwort implements eine Auflistung der implementierten Schnittstellen. So implementiert die Klasse RandomAccessFile die Schnittstellen DataOutput, DataInput und Closeable:
Um zu einem vorhandenen Class-Objekt die Schnittstellen aufzulisten, rufen wir getInterfaces() auf, die uns ein Array von Class-Objekten liefert. Von hier aus kennen wir den Weg zum Namen: Der Aufruf von getName() liefert den String für den Namen der Schnittstelle.
[zB]Beispiel
Gib die implementierten Schnittstellen von RandomAccessFile aus:
Listing 17.7com/tutego/insel/meta/ShowInterfaces.java, main()
System.out.println( theInterface.getName() );
Die Ausgabe ist:
java.io.DataInput
java.io.Closeable
17.4.6Modifizierer und die Klasse Modifier *
Eine Klassendeklaration kann Modifizierer enthalten, also Schlüsselwörter, die zum Beispiel die Sichtbarkeit bestimmen. Unter anderem sind dies public, protected, private und final. Sie stehen etwa in der Klassendeklaration vor dem Schlüsselwort class oder auch vor Methoden. Die Modifizierer können auch kombiniert werden: So ist die Klasse Class selbst public final. Die Methode getModifiers() liefert im Rückgabewert die Modifizierer, verschlüsselt als Ganzzahl:
System.out.println( Modifier.toString(Modifier.class.getModifiers()) ); // public
implements Serializable, GenericDeclaration, Type, AnnotatedElement
int getModifiers()
Liefert die Modifizierer für eine Klasse oder eine Schnittstelle.
Dekodieren der Zahlrepräsentationen durch die Klasse Modifier
Damit wir uns bei der Entschlüsselung nicht mit magischen Zahlenwerten der JVM herumschlagen müssen, gibt es in der Klasse java.lang.reflect.Modifier einige statische Methoden, die diese Ganzzahl testen und aufbauen. Zudem werden Konstanten deklariert (wie Modifier.PUBLIC), mit denen dieser Ganzzahlwert verglichen werden kann. Da die Ganzzahl potenziell eine Kombination mehrerer Modifizierer kodiert, ist die gezielte Abfrage allerdings mit den statischen isXXX(…)-Methoden einfacher. Obwohl eine Klasse nicht transient, synchronized, nativ sein kann, listen wir hier alle statischen Methoden auf, da wir diese Modifizierer später auch für die Untersuchung von Methoden und Objekt- bzw. Klassenvariablen per Reflection einsetzen. Jede dieser Testmethoden liefert true, wenn der gefragte Modifizierer in dem kodierten Ganzzahlwert enthalten ist. Alle Methoden sind static und liefern ein boolean-Ergebnis, außer toString().
static boolean isAbstract(int mod)
static boolean isFinal(int mod)
static boolean isInterface(int mod)
static boolean isNative(int mod)
static boolean isPrivate(int mod)
static boolean isProtected(int mod)
static boolean isPublic(int mod)
static boolean isStatic(int mod)
static boolean isSynchronized(int mod)
static boolean isTransient(int mod)
static boolean isVolatile(int mod)
static boolean isDefault(int mod) (seit Java 8)
Des Weiteren gibt es xxxModifier()-Methoden, die über ein int aussagen, welche Modifizierer an einem bestimmten Element erlaubt sind:
static int classModifiers()
static int constructorModifiers()
static int fieldModifiers()
static int interfaceModifiers()
static int methodModifiers()
static int parameterModifiers()
Liefert ein int, das alle Modifizierer kodiert, die an Klassen/Konstruktoren/Feldern/Schnittstellen/Methoden/Methodenparametern erlaubt sind. So liefert constructorModifiers() zum Beispiel Modifier.PUBLIC | Modifier.PROTECTED | Modifier.PRIVATE.
[»]Hinweis
Schnittstellen, wie java.io.Serializable, tragen den Modifier abstract:
System.out.println( mod ); // 1537
System.out.println( (mod & Modifier.PUBLIC) != 0); // true
System.out.println( (mod & Modifier.ABSTRACT) != 0); // true
System.out.println( Modifier.toString(mod) ); // public abstract interface
17.4.7Die Arbeit auf dem Feld *
Die Utility-Klasse java.lang.reflect.Array stellt statische Methoden bereit, um auf Array-Objekten generisch zu arbeiten. Elemente lassen sich erfragen und setzen und auch Arrays mit einem gewünschten Typ anlegen:
System.out.println( Array.getLength(array) ); // 20
Array.setInt( array, 0, –1 );
System.out.println( Array.getInt(array, 0) ); // –1
Bei newInstance(…) ist der Typ int.class und nicht int[].class!
Eine allgemeine statische Array-Methode set(…) und auch get(…) arbeiten für Objekte, wobei auch Wrapper für primitive Felder verwendet werden können:
System.out.println( Array.get(array, 0) ); // –1
Für mehrdimensionale Felder lässt sich bei newInstance(…) ein Feld von Größen angeben:
((int[][])array)[0][0] = 1;
((int[][])array)[1][1] = 1;
System.out.println( Arrays.deepToString( (int[][])array ) ); // [[1, 0], [0, 1]]