Le type de retour "This" en Java

Grimly — Thu, 12 Nov 2015 16:51:27 GMT

Bonjour,

Pendant certains de mes d�veloppements en Java j'ai bien souvent pest� contre l'api java.nio et ses classes Buffer qui ne permettent jamais compl�tement un cha�nage des commandes (ce qui est propos� reste tr�s int�ressant n�anmoins).
J'ai tent� pas mal de fois de contourner ce probl�me jusqu'� trouver une astuce avec les types g�n�riques.

Je vais d�crire mon raisonnement ci-dessous avec une classe "Buffer" et une m�thode "position" comme ce que propose java.nio.Buffer

La premi�re �tape est de choisir un nom pour le type g�n�rique. On prendra ici "This".
Code java : S�lectionner tout - Visualiser dans une fen�tre � part
1
2
3
public class Buffer {
    public This position(int position) { return null; }
}
Ensuite il faut d�finir ce This de fa�on � ce que le cha�nage puisse se r�aliser. On le fera alors �tendre la classe Buffer elle m�me.
Afin de terminer la d�finition, le type This est r�utilis� dans la classe parent de This.
On pourra alors terminer l'impl�mentation avec un retour de "this" au lieu de "null".
Code java : S�lectionner tout - Visualiser dans une fen�tre � part
1
2
3
public class Bufferextends Buffer> {
    public This position(int position) { return this; }
}
D�s lors on peut tr�s facilement cha�ner nos appels de m�thodes.
Code java : S�lectionner tout - Visualiser dans une fen�tre � part
1
2
Buffer buffer = new Buffer();
buffer.position(0).position(5);
Le probl�me maintenant est sur la d�claration du composant g�n�rique � l'utilisation.
Ici, un IDE consciencieux vous dira que le type g�n�rique n'est pas d�fini et qu'il faut le pr�ciser.

Le type Object ne r�ponds pas au crit�re car il n'h�rite pas de Buffer.
Le type Buffer est correct (Buffer) mais on retrouve exactement le m�me probl�me sur la suite de la d�finition
En java le caract�re "?" permet de d�finir un type g�n�rique non d�fini. Ici il convient parfaitement car bien que nous ne pr�cisons pas de type pr�cis, le compilateur sais au sein de la classe Buffer que "This" est au moins un type "Buffer".

Le code client sera alors le suivant :

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
Buffer buffer = new Buffer<>(); buffer.position(0).position(5);

Passons maintenant � l'h�ritage.
Imaginons un type ByteBuffer qui �tends Buffer avec une nouvelle m�thode "put".
L'astuce ici est de pr�ciser plus finement le param�tre This pour maintenant �tendre ByteBuffer et non Buffer.

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
public class ByteBufferextends ByteBuffer> extends Buffer { public This put(byte b) { return this; } }

Le code client ne change pas tellement si on garde le m�me type de d�part, � savoir Buffer :

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
Buffer buffer = new ByteBuffer<>(); buffer.position(0).position(5);

On remarquera que comme nous avons d�clar� la variable "buffer" comme �tant un "Buffer", nous n'avons pas acc�s � la m�thode "put" et nous gardons la vision d'un objet Buffer.

Lors de l'utilisation du type ByteBuffer, nous pouvons cha�ner les op�rations de la classe ByteBuffer avec les op�rations de la classe Buffer comme suit :

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
ByteBuffer buffer = new ByteBuffer<>(); buffer.position(0).put((byte)5).position(5).put((byte)250);

Imaginons maintenant un nouveau type de Buffer qui prends en charge n'importe quel type, param�tr�, d'�l�ment, ObjectBuffer.
Sa d�claration sera fortement semblable que pour ByteBuffer :

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
public class ObjectBufferextends ObjectBuffer> extends Buffer { public This put(Element e) { return this; } }

Il est � noter ici que les autres types param�tr�s sont r�p�t�s syst�matiquement. C'est ici que se trouve le co�t de notre "This" dans la d�claration de notre classe.

Le code client devra � nouveau omettre le type "This" qu'il ne nous int�resse pas de d�finir :

Code java : S�lectionner tout - Visualiser dans une fen�tre � part

1
2
ObjectBuffer buffer = new ObjectBuffer<>(); buffer.position(0).put("zero").position(5).put("cinq");

Cette notation permet aussi d'effectuer du prototypage au lieu d'un objet mutable. On peut imaginer de m�me qu'au lieu de l'instruction "return this;", l'objet retourn� soit une copie.

Beaucoup de r�flexion pour ce sucre syntaxique. Mais ce n'est pas la premi�re fois que je relevais ce probl�me sur l'API java.nio et je pense que d'autres l'ont aussi not�.

Forum du club des d�veloppeurs et IT Pro - Blogs - Grimly

Le type de retour "This" en Java