Java de la méthode add() de la convention de

Donc, je suis normalement un programmeur ruby, donc ma prise de conventions Java est fragile, au mieux. Si j'ai une classe A et souhaitez définir une méthode pour ajouter deux instances de cette classe, ce qui est la convention sur le comportement et le type de retour?

public class A
{
    //...
    public NotSureWhatTypeItShouldReturn add (A that) { /* ... */ }

Dois-Je

  • retourner un booléen indiquant la réussite et de modifier la cible, ou
  • retour une copie modifiée de la cible et de lever une exception en cas d'erreur

Ce qui correspond à la Java normal convention pour ce genre de méthode?

Votre question implique que la classe contenant la 'ajouter' est une méthode de collecte, mais ce n'est probablement pas le cas pouvez-vous préciser?
En réalité, c'est une mise en œuvre de Iterable. Le traiter comme un Collection ne semble pas faire sens (puisque je ne veux pas ajouter des membres individuels), mais je ne veux pas la capacité de combiner les deux instances dans un seul Iterable qui va se répéter sur tous les membres de chaque.
De la manière dont les OP libellé de la question, et l'extrait de code montré, je crois que nous ne traitons pas avec des collections, mais plutôt quelque chose comme BigDecimal où vous pouvez ajouter une instance à l'autre.
Je mispoke, Iterableest seulement l'une des deux situations dans lesquelles je vais utiliser cette - je vais aussi faire l'addition vectorielle pour une autre classe, par exemple,[1 2 3] + [4 -1 0] = [5 1 3].
bon appel sur concatenate. Je pense que je vais voler plus de Jon Skeet de réponse pour mon cas d'addition de vecteurs.

OriginalL'auteur rampion | 2010-06-18

  1. 3

    Tout le monde ici est de penser à des Collections.ajouter()-type de méthode; mais je doute que c'est ce que vous pensez. Êtes-vous plus dans la ligne de, disons, Vector2D.add() qui ajoute le x et y de la composante de la Vector2D ensemble?

    En Java, aussi loin que je peux dire, Collections généralement modifier eux-mêmes (et donc ne les Collections.ajouter).

    Cependant, la non-Collections d'objets (par exemple, Vector2D) varie plus. Parmi les conventions que j'ai vu:

    1. Cls add(Cls b) qui renvoie un nouvel objet et de ne pas modifier les instances existantes
    2. void add(Cls b) qui modifie this et ne renvoie rien (c'est à dire de type void), il ne doit pas modifier b. Il n'y a pas de point de retour bool puisque ce type d'ajout est jamais censé à l'échec (et si ce n'est de toute façon, une Exception serait le cas).
    3. Cls add(Cls a, Cls b) qui renvoie un nouvel objet, modifie ni a, ni b. Cls.add() est une méthode statique dans la classe Cls.

    Personnellement, je préfère le premier style de l'arithmétique de style add(); c'est précisément parce que nous pouvons faire.ajouter(b).ajouter(c).ajouter(d) qui ressemble un peu à "a + b + c + d". (Je ne devrais pas faire cela si a est une Collection; puisque la série plus un peu bizarre pour les Collections d'objets.)

    Je suis d'accord, mettre en œuvre vos objets immutables, et à l'aide de votre Vector2d exemple: Vector2d a = new Vecteur(1,2); Vector2d b = new Vecteur(3,4); Vector2d c = un.add(b); //a = (1,2) //b = (3,4) //c = (4,6)

    OriginalL'auteur Lie Ryan

  2. 6

    Les deux existent: de la Collection.ajouter modifie la collecte et renvoie un booléen, et BigInteger.ajouter retourne une nouvelle BigInteger qui détient la somme de l'original et le passé-en instance.

    Je généralement s'attendre à la plupart des méthodes pour modifier l'instance qu'ils sont appelés sur la, plutôt que de retourner un objet de même type, mais si il y a un bon cas d'utilisation pour garder les instances const et de renvoyer une nouvelle instance à tout moment, vous pouvez certainement le faire

    +1, pour la mention de l'ajout de numéros. L'OP n'a jamais dit qu'il était d'ajouter à une collection de choses 😉

    OriginalL'auteur Michael Mrozek

  3. 5

    Ne pas retourner un booléen sauf si c'est un "échec attendu" par exemple, essayez d'ajouter à un ensemble. Si quelque chose va effectivement mal, lance une exception.

    Maintenant, vous pourrait retour une copie modifiée ou vous pouvez ajouter de l'objet existant. L'immuabilité est souvent une belle propriété... mais la plupart des collections en Java sont mutables. Si vous allez en bas de la immuables de l'itinéraire que vous pourriez vouloir envisager à l'aide de plus au lieu de add - il donne plus d'un sentiment de "il y a un résultat, vous devriez regarder, et je ne vais pas changer de cible" de l'OMI.

    OriginalL'auteur Jon Skeet

  4. 1

    Je recommanderais le même comportement que dans Collection.ajouter, c'est ce à quoi je m'attends.

    OriginalL'auteur stacker

  5. 0

    De la Java Les Collections de l'API:

    Assure que cette collection contient l'élément spécifié (facultatif de l'opération). Retourne true si cette collection a changé par suite de l'appel. (Retourne false si cette collection n'a pas permis de doublons et contient déjà l'élément spécifié.)

    Collections qui prennent en charge cette opération peut placer des restrictions sur ce que les éléments peuvent être ajoutés à cette collection. En particulier, certaines collections de refuser l'ajout d'éléments null, et d'autres vont imposer des restrictions sur le type d'éléments qui peuvent être ajoutés. Les classes de Collection doit préciser clairement dans la documentation de toutes les restrictions sur ce que les éléments peuvent être ajoutés.

    Si une collection refuse d'ajouter un élément en particulier pour une raison quelconque autre que celui qu'elle contient déjà un élément, il doit lever une exception (plutôt que de retourner false). Cela préserve l'invariant qu'une collection contient toujours l'élément spécifié après cet appel retourne.

    OriginalL'auteur MikeD

  6. 0

    Ceci n'est pas une convention, mais seulement ce que boolean Collection<E>.ajouter(E) illustre:

    Retourne: true si cette collection a changé par suite de l'appel

    Jette: UnsupportedOperationException - si le add opération n'est pas pris en charge par cette collection

    Méthodes de la Java des Collections de classes du Framework rarement renvoie la collection qu'ils sont invoqués lors de l'. C'est, il n'est pas idiomatiques à l'appui de cette:

    mySet.add(thisThing).add(thatThing).add(thoseAlso);

    Certaines classes dans les bibliothèques Java employer le "fluide" de style, par exemple Appendable comme StringBuilder, mais aucune des principales Collections Java les classes du Framework faire.

    OriginalL'auteur polygenelubricants

  7. 0

    Dépend de la sémantique de votre classe, mais en général, ce serait:

    public void add( A that ) {
}

    Si ce que vous avez l'intention est seulement d'agréger les éléments.

    Vous pouvez utiliser:

    public boolean add( A that ) {
}

    Si votre intention est de savoir si la structure a été modifiée ou n'est pas ( Comme avec un java.util.Set ou des collections en général )

    Et vous pouvez utiliser public A add( A that ){} si votre intention est de créer un "constructeur comme" objet ( comme StringBuilder.append méthode. 

     A a = new A();
 a.add( a ).add( b ).add( c ).build();

    Donc, en fonction de la sémantique de votre classe que vous pourriez utiliser.

    La plupart du temps (+de 90%) je ne la première: void add( A other ){}

    OriginalL'auteur OscarRyz