Project

General

Profile

Revision da270d9c

IDda270d9c3a72f58c5d178f42116a0e621016f23e
Parent 1ac1ab0b
Child 0c72327c

Added by Patrick Plitzner about 3 years ago

ref #6694 Fix javadoc

View differences:

cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/Character.java
8 8
*/
9 9
package eu.etaxonomy.cdm.model.description;
10 10

  
11
import java.util.List;
12

  
13 11
import javax.persistence.Entity;
14 12
import javax.persistence.FetchType;
15 13
import javax.persistence.ManyToOne;
......
22 20
import javax.xml.bind.annotation.XmlType;
23 21

  
24 22
import org.apache.log4j.Logger;
25
import org.hibernate.annotations.Cascade;
26
import org.hibernate.annotations.CascadeType;
27 23
import org.hibernate.envers.Audited;
28 24
import org.hibernate.search.annotations.IndexedEmbedded;
29 25

  
......
76 72
/* ***************** CONSTRUCTOR AND FACTORY METHODS **********************************/
77 73

  
78 74

  
79
    /**
80
     * Creates a new empty feature instance.
81
     *
82
     * @see #NewInstance(String, String, String)
83
     */
84 75
    public static Character NewInstance() {
85 76
        return new Character();
86 77
    }
87 78

  
79

  
88 80
    /**
89
     * Creates a new feature instance with a description (in the {@link Language#DEFAULT() default language}),
90
     * a label and a label abbreviation.
81
     * Class constructor: creates a new character instance associated with
82
     * the given structure and property node
91 83
     *
92
     * @param   term         the string (in the default language) describing the
93
     *                       new feature to be created
94
     * @param   label        the string identifying the new feature to be created
95
     * @param   labelAbbrev  the string identifying (in abbreviated form) the
96
     *                       new feature to be created
97
     * @see                  #readCsvLine(List, Language)
98
     * @see                  #NewInstance()
84
     * @param structure The structure feature node for this character
85
     * @param property The property feature node for this character
86
     * @see #Feature()
99 87
     */
100 88
    public static Character NewInstance(FeatureNode structure, FeatureNode property){
101 89
        return new Character(structure, property, null, null, null);
102 90
    }
103 91

  
92

  
93
    /**
94
     * Class constructor: creates a new character instance associated with
95
     * the given structure and property node with a description
96
     * (in the {@link Language#DEFAULT() default language}), a label and a label
97
     * abbreviation.
98
     *
99
     * @param structure The structure feature node for this character
100
     * @param property The property feature node for this character
101
     * @param term
102
     *            the string (in the default language) describing the new
103
     *            feature to be created
104
     * @param label
105
     *            the string identifying the new feature to be created
106
     * @param labelAbbrev
107
     *            the string identifying (in abbreviated form) the new feature
108
     *            to be created
109
     * @see #Feature()
110
     */
104 111
    public static Character NewInstance(FeatureNode structure, FeatureNode property, String term, String label, String labelAbbrev){
105 112
        return new Character(structure, property, term, label, labelAbbrev);
106 113
    }
......
114 121

  
115 122

  
116 123
    /**
117
     * Class constructor: creates a new feature instance with a description (in the {@link Language#DEFAULT() default language}),
118
     * a label and a label abbreviation.
124
     * Class constructor: creates a new character instance associated with
125
     * the given structure and property node with a description
126
     * (in the {@link Language#DEFAULT() default language}), a label and a label
127
     * abbreviation.
119 128
     *
120
     * @param   term         the string (in the default language) describing the
121
     *                       new feature to be created
122
     * @param   label        the string identifying the new feature to be created
123
     * @param   labelAbbrev  the string identifying (in abbreviated form) the
124
     *                       new feature to be created
125
     * @see                  #Feature()
129
     * @param structure The structure feature node for this character
130
     * @param property The property feature node for this character
131
     * @param term
132
     *            the string (in the default language) describing the new
133
     *            feature to be created
134
     * @param label
135
     *            the string identifying the new feature to be created
136
     * @param labelAbbrev
137
     *            the string identifying (in abbreviated form) the new feature
138
     *            to be created
139
     * @see #Feature()
126 140
     */
127 141
    protected Character(FeatureNode structure, FeatureNode property, String term, String label, String labelAbbrev) {
128 142
        super(term, label, labelAbbrev);

Also available in: Unified diff

Add picture from clipboard (Maximum size: 40 MB)