23.3 Attribute, Methoden und Konstruktoren

Ein Class-Objekt bietet nicht nur Zugriff auf Oberklassen, Sichtbarkeiten, Modifizierer und Schnittstellen, sondern natürlich auch auf die Variablen, Methoden und Konstruktoren einer Klasse oder Schnittstelle. Daher kooperiert Class mit fünf weiteren Typen:

• Constructor. Steht für die Konstruktoren einer Klasse. Es gibt zum Beispiel getConstructors() ein Feld von Konstruktoren zurück.

• Field. Ermöglicht Zugriff auf die Objekt- und Klassenvariablen, um später Belegungen lesen und Werte verändern zu können.

• Method. Steht für die Methoden einer Klasse beziehungsweise Operationen der Schnittstellen. Es liefert getDeclaredMethods() die Methoden, die dann später mit invoke() aufgerufen werden können.

• Annotation. Repräsentiert die Annotationen, die an der Klasse/Schnittstelle festgemacht sind. So liefert zum Beispiel die Class-Methode getAnnotations() die festgemachten Annotationen.

• Package. Es liefert getPackage() ein Package-Objekt für die Klasse, die eine Versionsnummer beinhaltet, wenn diese im Manifest gesetzt wurde.

Weiterhin gibt es folgende allgemeine Implementierungsbeziehungen:

• Die Klassen Class, Method, Field und Constructor implementieren eine Schnittstelle Member, um etwa den Namen, die Modifizierer oder die definierende Klasse zu erfragen.

• Die Klassen Class, Constructor und Method implementieren die Schnittstelle GenericDeclaration, da sie generische Typvariablen deklarieren können.

• Die Klassen Constructor, Field und Method implementieren AccessibleObject, um die Sichtbarkeit auszuschalten.

• Class, Constructor, Field, Method und Package implementieren AnnotatedElement, weil sie Annotationen tragen können.

23.3.1 Reflections Gespür für Attribute einer Klasse

Besonders bei Klassen-Browsern oder GUI-Buildern ist es interessant, auf die Variablen eines Objekts zuzugreifen, das heißt, ihre Werte auszulesen und zu verändern. Damit wir an beschreibende Objekte für die in einer Klasse definierten beziehungsweise aus Oberklassen geerbten Variablen gelangen, rufen wir die Methode getFields() für das Class-Objekt der interessierenden Klasse auf. Als Ergebnis erhalten wir ein Array von Field-Objekten. Jeder Array-Eintrag beschreibt eine Objekt- oder Klassenvariable, auf die wir zugreifen dürfen. Nur auf öffentliche, also public-Elemente, haben wir per (gewöhnlicher) Reflection Zugriff. (Auf eine privilegierte Reflection gehen wir hier nicht ein.) Schnittstellen definieren ja bekanntlich nur Konstanten. Somit ist der schreibende Zugriff, den wir später näher betrachten wollen, nur auf in Klassen definierte Variablen beschränkt. Lesen ist natürlich bei Konstanten und Variablen gleichermaßen erlaubt. Beim Zugriff auf die Attribute mittels getFields() müssen wir aufpassen, dass wir uns keine SecurityException einfangen. Das kann uns aber bei vielen Methoden passieren, und weil SecurityException eine RuntimeException ist, muss sie auch nicht extra aufgefangen werden. In der Dokumentation ist sie daher nicht angegeben.

Um für SimpleDateFormat alle Objekt- und Klassenvariablen mit ihren Datentypen herauszufinden, lassen wir eine Schleife über das Field-Array laufen. Die Namen der Variablen finden sich leicht mit getName(). Wir haben aber den zugehörigen Datentyp noch nicht. Dazu müssen wir erst mit getType() ein Class-Objekt für den Typ ermitteln, und dann liefert uns getName() eine String-Repräsentation des Typs.

Listing 23.6 com/tutego/insel/meta/ShowFields.java, main()

Class<?> c = java.text.SimpleDateFormat.class; 
System.out.println( "class " + c.getName() + " {" ); 
for ( Field publicField : c.getFields() ) { 
  String fieldName = publicField.getName(); 
  String fieldType = publicField.getType().getName(); 
  System.out.printf( "  %s %s;%n", fieldType, fieldName ); 
} 
System.out.println( "}" );

Dies ergibt die (gekürzte) Ausgabe:

class java.text.SimpleDateFormat { 
  int ERA_FIELD; 
  int YEAR_FIELD; 
  ... 
  int SHORT; 
  int DEFAULT; 
}

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• Field[] getFields() Liefert ein Array mit Field-Objekten. Die Einträge sind unsortiert. Das Array hat die Länge 0, wenn die Klasse beziehungsweise Schnittstelle keine öffentlichen Variablen definiert oder erbt. getFields() liefert automatisch auch Einträge für die aus Oberklassen beziehungsweise Schnittstellen geerbten öffentlichen Variablen.

• Field getField( String name ) throws NoSuchFieldException Erfragt ein bestimmtes Feld.

Die Klasse Field implementiert im Übrigen das Interface Member und ist eine Erweiterung von AccessibleObject. AccessibleObject ist die Basisklasse für Field-, Method- und Constructor-Objekte. Auch Method und Constructor implementieren das Interface Member, das zur Identifikation über getName() oder getModifiers() dient. Zusätzlich liefert getDeclaringClass() das Class-Objekt, das tatsächlich eine Variable oder Methode definiert. Da geerbte Elemente in der Aufzählung mit auftauchen, ist dies der einzige Weg, um die Position der Deklaration in der Vererbungshierarchie exakt zu bestimmen.

Das Field-Objekt lässt sich vieles fragen: nach dem Namen des Attributs, nach dem Datentyp und auch wieder nach den deklarierten Modifizierern. Werfen wir einen Blick auf die to-String()-Methode der Klasse Field:

public String toString() { 
  int mod = getModifiers(); 
  return (((mod == 0) ? "" : (Modifier.toString(mod) + " ")) 
      + getTypeName(getType()) + " " 
      + getTypeName(getDeclaringClass()) + "." 
      + getName()); 
}

for ( Field publicField : c.getFields() ) 
  System.out.println( "  " + publicFields );

class java.text.SimpleDateFormat { 
  public static final int java.text.DateFormat.ERA_FIELD 
  public static final int java.text.DateFormat.YEAR_FIELD 
  ... 
  public static final int java.text.DateFormat.SHORT 
  public static final int java.text.DateFormat.DEFAULT 
}

final class java.lang.reflect.Field 
extends AccessibleObject 
implements Member

• Class<?> getDeclaringClass() Liefert das Class-Exemplar für die Klasse oder die Schnittstelle, in der die Variable definiert wurde. Diese Methode ist Teil der Schnittstelle Member.

• int getModifiers() Liefert die deklarierten Modifizierer für die Variable.

• String getName() Liefert den Namen der Variable. Diese Methode ist Teil der Schnittstelle Member.

• Class<?> getType() Liefert ein Class-Objekt, das dem Datentyp der Variable entspricht.

• String toString() Liefert eine String-Repräsentation. Am Anfang stehen die Sichtbarkeitsmodifizierer (public, protected oder private), und es folgen die weiteren Modifizierer (static, final, transient, volatile). Dann kommt der Datentyp, gefolgt vom voll qualifizierten Namen der definierenden Klasse und schließlich der Name der Variable.

23.3.2 Methoden einer Klasse erfragen

Um herauszufinden, über welche Methoden eine Klasse verfügt, wenden wir eine ähnliche Vorgehensweise an wie bei den Variablen: getMethods(). Diese Methode liefert ein Array mit Method-Objekten. Über ein Method-Objekt lassen sich Methodenname, Ergebnistyp, Parametertypen, Modifizierer und eventuell resultierende Exceptions erfragen. Wir werden später sehen, dass sich die durch ein Method-Exemplar repräsentierte Methode über invoke() aufrufen lässt.

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• Method[] getMethods() Gibt ein Array von Method-Objekten zurück, die alle öffentlichen Methoden der Klasse/Schnittstelle beschreiben. Geerbte Methoden werden mit in die Liste übernommen. Die Elemente sind nicht sortiert, und die Länge des Arrays ist null, wenn es keine öffentlichen Methoden gibt.

• Method getMethod( String name, Class... parameterTypes ) throws NoSuchMethodException Liefert zu einem Methodennamen und einer Parameterliste das passende Method-Objekt oder löst eine NoSuchMethodException aus. Besitzt die Methode keine Parameter – wie eine übliche getXXX()-Methode –, ist das Argument null und wird wegen der Varargs auf Class[] angepasst.

Nachdem wir nun mittels getMethods() ein Array von Method-Objekten erhalten haben, lassen die Method-Objekte verschiedene Abfragen zu. So liefert getName() den Namen der Methode, getReturnType() den Ergebnistyp, und getParameterTypes() erzeugt ein Array von Class-Objekten, das die Typen der Methodenparameter widerspiegelt. Wir kennen dies schon von den Attributen.

Wir wollen nun ein Programm angeben, das alle Methoden und ihre Parametertypen sowie Ausnahmen ausgibt.

Listing 23.7 com/tutego/insel/meta/ShowMethods.java

package com.tutego.insel.meta; 
 
import java.lang.reflect.*; 
 
class ShowMethods 
{ 
  public static void main( String[] args ) 
  { 
    showMethods( java.awt.Color.BLACK ); 
  } 
 
  static void showMethods( Object o ) 
  { 
    for ( Method method : o.getClass().getMethods() ) 
    { 
      // Rückgabetyp 
      String returnString = method.getReturnType().getName(); 
 
      // Methodenname 
      String methodString = method.getName(); 
 
      System.out.print( returnString + " " + methodString + "(" ); 
 
      // Parameter 
      Class<?>[] parameterTypes = method.getParameterTypes(); 
 
      for ( int k = 0; k < parameterTypes.length; k++ ) { 
        String parameterString = parameterTypes[k].getName(); 
        System.out.print( " " + parameterString ); 
 
        if ( k < parameterTypes.length – 1 ) 
          System.out.print( ", " ); 
      } 
      System.out.print( " )" ); 
 
      // Exceptions 
      Class<?>[] exceptions = method.getExceptionTypes(); 
 
      if ( exceptions.length > 0 ) { 
        System.out.print( " throws " ); 
        for ( int k = 0; k < exceptions.length; k++ ) { 
          System.out.print( exceptions[k].getName() ); 
          if ( k < exceptions.length – 1 ) 
            System.out.print( ", " ); 
        } 
      } 
 
      System.out.println(); 
    } 
  } 
}

Die Ausgabe sieht gekürzt so aus:

int hashCode( ) 
boolean equals( java.lang.Object ) 
java.lang.String toString( ) 
... 
[F getRGBColorComponents( [F ) 
... 
void wait( long ) throws java.lang.InterruptedException 
void notify( ) 
void notifyAll( )

Wir bemerken an einigen Stellen eine kryptische Notation, wie etwa »[F«. Dies ist aber lediglich wieder die schon erwähnte Kodierung für Array-Typen. So gibt getRGB-Components() ein float-Array zurück und erwartet ein float-Array als Argument.

final class java.lang.reflect.Method 
extends AccessibleObject 
implements GenericDeclaration, Member

• Class<?> getDeclaringClass() Liefert das Class-Exemplar für die Klasse oder die Schnittstelle, in der die Methode definiert wurde. Diese Methode ist Teil der Schnittstelle Member.

• String getName() Liefert den Namen der Methode. Diese Methode ist Teil der Schnittstelle Member.

• int getModifiers() Liefert die Modifizierer. Diese Methode ist Teil der Schnittstelle Member.

• Class<?> getReturnType() Gibt ein Class-Objekt zurück, das den Ergebnistyp beschreibt.

• Class<?>[] getParameterTypes() Liefert ein Array von Class-Objekten, die die Typen der Parameter beschreiben. Die Reihenfolge entspricht der deklarierten Parameterliste. Das Array hat die Länge null, wenn die Methode keine Parameter erwartet.

• Class<?>[] getExceptionTypes() Liefert ein Array von Class-Objekten, die mögliche Exceptions beschreiben. Das Array hat die Länge null, wenn die Methode keine solchen Exceptions mittels throws deklariert. Das Feld spiegelt nur die throws-Klausel wider. Sie kann prinzipiell auch zu viele Exceptions enthalten, bei einer Funktion foo() throws RuntimeException, NullPointerException etwa genau die beiden Ausnahmen.

• String toString() Liefert eine String-Repräsentation der Methode, ähnlich dem Methodenkopf in einer Deklaration.

23.3.3 Properties einer Bean erfragen

Eine Bean besitzt Properties (Eigenschaften), die in Java (bisher) durch Setter und Getter ausgedrückt werden, also Methoden, die einer festen Namenskonvention folgen. Gibt es Interesse an den Properties, lässt sich natürlich getMethods() auf dem Class-Objekt aufrufen und nach den Methoden filtern, die der Namenskonvention entsprechen. Die Java-Bibliothek bietet aber im Paket java.beans eine einfachere Lösung für Beans: einen PropertyDescriptor.

BeanInfo beanInfo = Introspector.getBeanInfo( Color.class ); 
for ( PropertyDescriptor pd : beanInfo.getPropertyDescriptors() ) 
  System.out.println( pd.getDisplayName() + " : " + 
                      pd.getPropertyType().getName() );

RGB : int 
alpha : int 
blue : int 
class : java.lang.Class 
colorSpace : java.awt.color.ColorSpace 
green : int 
red : int 
transparency : int

Interessanter sind vom PropertyDescriptor die Methoden getReadMethod() und getWriteMethod(), die beides ein Method-Objekt liefern – sofern es verfügbar ist – um so die Methode gleich aufrufen zu können.

BeanInfo liefert mit getPropertyDescriptors() zwar die Properties, kann jedoch über getMethodDescriptors() auch alle anderen Methoden liefern.

23.3.4 Konstruktoren einer Klasse

Konstruktoren und Methoden haben einige Gemeinsamkeiten, unterscheiden sich aber insofern, als Konstruktoren keinen Rückgabewert haben. Die Ähnlichkeit zeigt sich auch in der Methode getConstructors(), die ein Array von Constructor-Objekten zurückgibt. Über dieses Array lassen sich dann wieder Name, Modifizierer, Parameter und Exceptions der Konstruktoren einer Klasse erfragen. Wie wir an einer späteren Stelle sehen werden, lassen sich auch über die Methode newInstance() neue Objekte erzeugen. Wegen der weitgehenden Ähnlichkeit der Klassen Constructor und Method sind die folgenden Methoden hier nicht näher beschrieben.

for ( Constructor<?> c : java.awt.Color.class.getConstructors() ) 
  System.out.println( c );

public java.awt.Color(float,float,float,float) 
public java.awt.Color(int) 
public java.awt.Color(int,int,int) 
public java.awt.Color(int,int,int,int) 
public java.awt.Color(java.awt.color.ColorSpace,float[],float) 
public java.awt.Color(int,boolean) 
public java.awt.Color(float,float,float)

final class java.lang.Class<T> 
implements Serializable, GenericDeclaration, Type, AnnotatedElement

• Constructor[] getConstructors() Liefert ein Feld mit Constructor-Objekten.

• Constructor<T> getConstructor( Class... parameterTypes ) throws NoSuchMethodException Liefert ein ausgewähltes Constructor-Objekt.

final class java.lang.reflect.Constructor<T> 
extends AccessibleObject 
implements GenericDeclaration, Member

• Class<T> getDeclaringClass() Eine ziemlich langweilige Funktion, da Konstruktoren nicht vererbt werden. Sie gibt immer nur jene Klasse aus, von der das Class-Objekt kommt. Das ist ein wichtiger Unterschied zwischen Methoden und Konstruktoren, der bei dieser Methode deutlich auffällt.

• Class[] getExceptionTypes()

• int getModifiers()

• String getName()

• Class[] getParameterTypes()

23.3.5 Annotationen

Ob Annotationen zur Laufzeit vorhanden sind, erfragen Methoden der Schnittstelle AnnotatedElement, die unter anderem Class, Constructor, Field, Method, Package implementieren. Ein Blick in AnnotatedElement verrät, wie an die Annotationen heranzukommen ist:

interface java.lang.reflect.AnnotatedElement

• Annotation[] getAnnotations() Liefert alle an diesem Element assoziierten Annotationen.

• Annotation[] getDeclaredAnnotations() Liefert alle an diesem Element definierten Annotationen. Vererbte Annotationen werden ignoriert.

• boolean isAnnotationPresent( Class<? extends Annotation> annotationType ) Erfragt, ob das Element eine bestimmte Annotation besitzt.

• <T extends Annotation> T getAnnotation( Class<T> annotationType ) Liefert die Annotationen eines gewünschten Typs.

Im späteren Unterkapitel kommen wir auf Annotationen zurück.

Ihr Kommentar