Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultEvent.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultEvent.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultEvent.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultEvent.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -54,6 +54,7 @@ import static org.apache.sis.internal.me * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Event_Type", propOrder = { "identifier", "trigger", @@ -117,7 +118,7 @@ public class DefaultEvent extends ISOMet * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Event) */ @@ -149,8 +150,8 @@ public class DefaultEvent extends ISOMet * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultEvent castOrCopy(final Event object) { @@ -163,7 +164,7 @@ public class DefaultEvent extends ISOMet /** * Returns the event name or number. * - * @return Event name or number, or {@code null}. + * @return event name or number, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -174,7 +175,7 @@ public class DefaultEvent extends ISOMet /** * Sets the event name or number. * - * @param newValue The event identifier value. + * @param newValue the event identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -185,7 +186,7 @@ public class DefaultEvent extends ISOMet /** * Returns the initiator of the event. * - * @return Initiator of the event, or {@code null}. + * @return initiator of the event, or {@code null}. */ @Override @XmlElement(name = "trigger", required = true) @@ -196,7 +197,7 @@ public class DefaultEvent extends ISOMet /** * Sets the initiator of the event. * - * @param newValue The new trigger value. + * @param newValue the new trigger value. */ public void setTrigger(final Trigger newValue) { checkWritePermission(); @@ -206,7 +207,7 @@ public class DefaultEvent extends ISOMet /** * Meaning of the event. * - * @return Meaning of the event, or {@code null}. + * @return meaning of the event, or {@code null}. */ @Override @XmlElement(name = "context", required = true) @@ -217,7 +218,7 @@ public class DefaultEvent extends ISOMet /** * Sets the meaning of the event. * - * @param newValue The new context value. + * @param newValue the new context value. */ public void setContext(final Context newValue) { checkWritePermission(); @@ -227,7 +228,7 @@ public class DefaultEvent extends ISOMet /** * Returns the relative time ordering of the event. * - * @return Relative time ordering, or {@code null}. + * @return relative time ordering, or {@code null}. */ @Override @XmlElement(name = "sequence", required = true) @@ -238,7 +239,7 @@ public class DefaultEvent extends ISOMet /** * Sets the relative time ordering of the event. * - * @param newValue The new sequence value. + * @param newValue the new sequence value. */ public void setSequence(final Sequence newValue) { checkWritePermission(); @@ -248,7 +249,7 @@ public class DefaultEvent extends ISOMet /** * Returns the time the event occurred. * - * @return Time the event occurred, or {@code null}. + * @return time the event occurred, or {@code null}. */ @Override @XmlElement(name = "time", required = true) @@ -259,7 +260,7 @@ public class DefaultEvent extends ISOMet /** * Sets the time the event occurred. * - * @param newValue The new time value. + * @param newValue the new time value. */ public void setTime(final Date newValue) { checkWritePermission(); @@ -269,7 +270,7 @@ public class DefaultEvent extends ISOMet /** * Returns the objective or objectives satisfied by an event. * - * @return Objectives satisfied by an event. + * @return objectives satisfied by an event. */ @Override @XmlElement(name = "expectedObjective") @@ -280,7 +281,7 @@ public class DefaultEvent extends ISOMet /** * Sets the objective or objectives satisfied by an event. * - * @param newValues The new expected objectives values. + * @param newValues the new expected objectives values. */ public void setExpectedObjectives(final Collection<? extends Objective> newValues) { expectedObjectives = writeCollection(newValues, expectedObjectives, Objective.class); @@ -289,7 +290,7 @@ public class DefaultEvent extends ISOMet /** * Returns the pass during which an event occurs. {@code null} if unspecified. * - * @return Pass during which an event occurs, or {@code null}. + * @return pass during which an event occurs, or {@code null}. */ @Override @XmlElement(name = "relatedPass") @@ -300,7 +301,7 @@ public class DefaultEvent extends ISOMet /** * Sets the pass during which an event occurs. * - * @param newValue The new platform pass value. + * @param newValue the new platform pass value. */ public void setRelatedPass(final PlatformPass newValue) { relatedPass = newValue; @@ -309,7 +310,7 @@ public class DefaultEvent extends ISOMet /** * Returns the instrument or instruments for which the event is meaningful. * - * @return Instruments for which the event is meaningful. + * @return instruments for which the event is meaningful. */ @Override @XmlElement(name = "relatedSensor") @@ -320,7 +321,7 @@ public class DefaultEvent extends ISOMet /** * Sets the instrument or instruments for which the event is meaningful. * - * @param newValues The new instrument values. + * @param newValues the new instrument values. */ public void setRelatedSensors(final Collection<? extends Instrument> newValues) { relatedSensors = writeCollection(newValues, relatedSensors, Instrument.class);
Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultInstrument.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultInstrument.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultInstrument.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultInstrument.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -47,6 +47,7 @@ import org.apache.sis.internal.jaxb.NonM * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Instrument_Type", propOrder = { "citations", "identifier", @@ -92,7 +93,7 @@ public class DefaultInstrument extends I * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Instrument) */ @@ -121,8 +122,8 @@ public class DefaultInstrument extends I * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultInstrument castOrCopy(final Instrument object) { @@ -135,7 +136,7 @@ public class DefaultInstrument extends I /** * Returns the complete citation of the instrument. * - * @return Complete citation of the instrument. + * @return complete citation of the instrument. */ @Override @XmlElement(name = "citation") @@ -146,7 +147,7 @@ public class DefaultInstrument extends I /** * Sets the complete citation of the instrument. * - * @param newValues The new citation values. + * @param newValues the new citation values. */ public void setCitations(final Collection<? extends Citation> newValues) { citations = writeCollection(newValues, citations, Citation.class); @@ -155,7 +156,7 @@ public class DefaultInstrument extends I /** * Returns the unique identification of the instrument. * - * @return Unique identification of the instrument, or {@code null}. + * @return unique identification of the instrument, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -166,7 +167,7 @@ public class DefaultInstrument extends I /** * Sets the unique identification of the instrument. * - * @param newValue The new identifier value. + * @param newValue the new identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -177,7 +178,7 @@ public class DefaultInstrument extends I /** * Returns the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame. * - * @return Type of instrument, or {@code null}. + * @return type of instrument, or {@code null}. */ @Override @XmlElement(name = "type", required = true) @@ -188,7 +189,7 @@ public class DefaultInstrument extends I /** * Sets the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame. * - * @param newValue The new type value. + * @param newValue the new type value. */ public void setType(final InternationalString newValue) { checkWritePermission(); @@ -198,7 +199,7 @@ public class DefaultInstrument extends I /** * Returns the textual description of the instrument. {@code null} if unspecified. * - * @return Textual description, or {@code null}. + * @return textual description, or {@code null}. */ @Override @XmlElement(name = "description") @@ -209,7 +210,7 @@ public class DefaultInstrument extends I /** * Sets the textual description of the instrument. * - * @param newValue The new description value. + * @param newValue the new description value. */ public void setDescription(final InternationalString newValue) { checkWritePermission(); @@ -219,7 +220,7 @@ public class DefaultInstrument extends I /** * Returns the platform on which the instrument is mounted. {@code null} if unspecified. * - * @return Platform on which the instrument is mounted, or {@code null}. + * @return platform on which the instrument is mounted, or {@code null}. */ @Override @XmlElement(name = "mountedOn") @@ -230,7 +231,7 @@ public class DefaultInstrument extends I /** * Sets the platform on which the instrument is mounted. * - * @param newValue The new platform value. + * @param newValue the new platform value. */ public void setMountedOn(final Platform newValue) { checkWritePermission(); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultObjective.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -51,6 +51,7 @@ import org.apache.sis.internal.jaxb.NonM * @version 0.7 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Objective_Type", propOrder = { "identifiers", "priority", @@ -115,7 +116,7 @@ public class DefaultObjective extends IS * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Objective) */ @@ -147,8 +148,8 @@ public class DefaultObjective extends IS * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultObjective castOrCopy(final Objective object) { @@ -170,7 +171,7 @@ public class DefaultObjective extends IS * The {@code <gmd:identifier>} element marshalled to XML will exclude all the above cited identifiers, * for ISO 19139 compliance. Those identifiers will appear in other XML elements or attributes.</div> * - * @return Identify the objective. + * @return identification of the objective. */ @Override @XmlElement(name = "identifier", required = true) @@ -184,7 +185,7 @@ public class DefaultObjective extends IS * <p>XML identifiers ({@linkplain IdentifierSpace#ID ID}, {@linkplain IdentifierSpace#UUID UUID}, <i>etc.</i>), * are not affected by this method, unless they are explicitely provided in the given collection.</p> * - * @param newValues The new identifiers values. + * @param newValues the new identifiers values. */ public void setIdentifiers(Collection<? extends Identifier> newValues) { newValues = NonMarshalledAuthority.setMarshallables(identifiers, newValues); @@ -194,7 +195,7 @@ public class DefaultObjective extends IS /** * Returns the priority applied to the target. {@code null} if unspecified. * - * @return Priority applied, or {@code null}. + * @return priority applied, or {@code null}. */ @Override @XmlElement(name = "priority") @@ -205,7 +206,7 @@ public class DefaultObjective extends IS /** * Sets the priority applied to the target. * - * @param newValue The new priority value. + * @param newValue the new priority value. */ public void setPriority(final InternationalString newValue) { checkWritePermission(); @@ -215,7 +216,7 @@ public class DefaultObjective extends IS /** * Returns the collection technique for the objective. * - * @return Collection technique for the objective. + * @return collection technique for the objective. */ @Override @XmlElement(name = "type") @@ -226,7 +227,7 @@ public class DefaultObjective extends IS /** * Sets the collection technique for the objective. * - * @param newValues The new types values. + * @param newValues the new types values. */ public void setTypes(final Collection<? extends ObjectiveType> newValues) { types = writeCollection(newValues, types, ObjectiveType.class); @@ -235,7 +236,7 @@ public class DefaultObjective extends IS /** * Returns the role or purpose performed by or activity performed at the objective. * - * @return Role or purpose performed by or activity performed at the objective. + * @return role or purpose performed by or activity performed at the objective. */ @Override @XmlElement(name = "function") @@ -246,7 +247,7 @@ public class DefaultObjective extends IS /** * Sets the role or purpose performed by or activity performed at the objective. * - * @param newValues The new functions values. + * @param newValues the new functions values. */ public void setFunctions(final Collection<? extends InternationalString> newValues) { functions = writeCollection(newValues, functions, InternationalString.class); @@ -256,7 +257,7 @@ public class DefaultObjective extends IS * Returns the extent information including the bounding box, bounding polygon, vertical and * temporal extent of the objective. * - * @return Extent information. + * @return extent information. */ @Override @XmlElement(name = "extent") @@ -268,7 +269,7 @@ public class DefaultObjective extends IS * Sets the extent information including the bounding box, bounding polygon, vertical and * temporal extent of the objective. * - * @param newValues The new extents values. + * @param newValues the new extents values. */ public void setExtents(final Collection<? extends Extent> newValues) { extents = writeCollection(newValues, extents, Extent.class); @@ -277,7 +278,7 @@ public class DefaultObjective extends IS /** * Returns the event or events associated with objective completion. * - * @return Events associated with objective completion. + * @return events associated with objective completion. */ @Override @XmlElement(name = "objectiveOccurence", required = true) @@ -288,7 +289,7 @@ public class DefaultObjective extends IS /** * Sets the event or events associated with objective completion. * - * @param newValues The new objective occurrences values. + * @param newValues the new objective occurrences values. */ public void setObjectiveOccurences(final Collection<? extends Event> newValues) { objectiveOccurences = writeCollection(newValues, objectiveOccurences, Event.class); @@ -297,7 +298,7 @@ public class DefaultObjective extends IS /** * Returns the pass of the platform over the objective. * - * @return Pass of the platform. + * @return pass of the platform. */ @Override @XmlElement(name = "pass") @@ -308,7 +309,7 @@ public class DefaultObjective extends IS /** * Sets the pass of the platform over the objective. * - * @param newValues The new pass values. + * @param newValues the new pass values. */ public void setPass(final Collection<? extends PlatformPass> newValues) { pass = writeCollection(newValues, pass, PlatformPass.class); @@ -317,7 +318,7 @@ public class DefaultObjective extends IS /** * Returns the instrument which senses the objective data. * - * @return Instrument which senses the objective data. + * @return instrument which senses the objective data. */ @Override @XmlElement(name = "sensingInstrument") @@ -328,7 +329,7 @@ public class DefaultObjective extends IS /** * Sets the instrument which senses the objective data. * - * @param newValues The new sensing instruments values. + * @param newValues the new sensing instruments values. */ public void setSensingInstruments(final Collection<? extends Instrument> newValues) { sensingInstruments = writeCollection(newValues, sensingInstruments, Instrument.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultOperation.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultOperation.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultOperation.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultOperation.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -52,6 +52,7 @@ import org.apache.sis.internal.jaxb.NonM * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Operation_Type", propOrder = { "description", "citation", @@ -133,7 +134,7 @@ public class DefaultOperation extends IS * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Operation) */ @@ -168,8 +169,8 @@ public class DefaultOperation extends IS * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultOperation castOrCopy(final Operation object) { @@ -183,7 +184,7 @@ public class DefaultOperation extends IS * Returns the description of the mission on which the platform observations are made and the * objectives of that mission. {@code null} if unspecified. * - * @return Description of the mission, or {@code null}. + * @return description of the mission, or {@code null}. */ @Override @XmlElement(name = "description") @@ -195,7 +196,7 @@ public class DefaultOperation extends IS * Sets the description of the mission on which the platform observations are made and the * objectives of that mission. * - * @param newValue The new description value. + * @param newValue the new description value. */ public void setDescription(final InternationalString newValue) { checkWritePermission(); @@ -205,7 +206,7 @@ public class DefaultOperation extends IS /** * Returns the identification of the mission. {@code null} if unspecified. * - * @return Identification of the mission, or {@code null}. + * @return identification of the mission, or {@code null}. */ @Override @XmlElement(name = "citation") @@ -216,7 +217,7 @@ public class DefaultOperation extends IS /** * Sets the identification of the mission. * - * @param newValue The new citation value. + * @param newValue the new citation value. */ public void setCitation(final Citation newValue) { checkWritePermission(); @@ -226,7 +227,7 @@ public class DefaultOperation extends IS /** * Returns the unique identification of the operation. * - * @return Unique identification of the operation, or {@code null}. + * @return unique identification of the operation, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -237,7 +238,7 @@ public class DefaultOperation extends IS /** * Sets the unique identification of the operation. * - * @param newValue The new identifier value. + * @param newValue the new identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -248,7 +249,7 @@ public class DefaultOperation extends IS /** * Returns the status of the data acquisition. * - * @return Status of the data acquisition, or {@code null}. + * @return status of the data acquisition, or {@code null}. */ @Override @XmlElement(name = "status", required = true) @@ -259,7 +260,7 @@ public class DefaultOperation extends IS /** * Sets the status of the data acquisition. * - * @param newValue The new status value. + * @param newValue the new status value. */ public void setStatus(final Progress newValue) { checkWritePermission(); @@ -269,7 +270,7 @@ public class DefaultOperation extends IS /** * Returns the collection technique for the operation. * - * @return Collection technique for the operation, or {@code null}. + * @return collection technique for the operation, or {@code null}. */ @Override @XmlElement(name = "type") @@ -280,7 +281,7 @@ public class DefaultOperation extends IS /** * Sets the collection technique for the operation. * - * @param newValue The new type value. + * @param newValue the new type value. */ public void setType(final OperationType newValue) { checkWritePermission(); @@ -290,7 +291,7 @@ public class DefaultOperation extends IS /** * Returns the sub-missions that make up part of a larger mission. * - * @return Sub-missions. + * @return sub-missions. */ @Override @XmlElement(name = "childOperation") @@ -301,7 +302,7 @@ public class DefaultOperation extends IS /** * Sets the sub-missions that make up part of a larger mission. * - * @param newValues The new child operations values. + * @param newValues the new child operations values. */ public void setChildOperations(final Collection<? extends Operation> newValues) { childOperations = writeCollection(newValues, childOperations, Operation.class); @@ -310,7 +311,7 @@ public class DefaultOperation extends IS /** * Returns object(s) or area(s) of interest to be sensed. * - * @return Object(s) or area(s) of interest. + * @return object(s) or area(s) of interest. */ @Override @XmlElement(name = "objective") @@ -321,7 +322,7 @@ public class DefaultOperation extends IS /** * Sets Object(s) or area(s) of interest to be sensed. * - * @param newValues The new objectives values. + * @param newValues the new objectives values. */ public void setObjectives(final Collection<? extends Objective> newValues) { objectives = writeCollection(newValues, objectives, Objective.class); @@ -330,7 +331,7 @@ public class DefaultOperation extends IS /** * Returns the heritage of the operation. * - * @return Heritage of the operation, or {@code null}. + * @return heritage of the operation, or {@code null}. */ @Override @XmlElement(name = "parentOperation", required = true) @@ -341,7 +342,7 @@ public class DefaultOperation extends IS /** * Sets the heritage of the operation. * - * @param newValue The new parent operation value. + * @param newValue the new parent operation value. */ public void setParentOperation(final Operation newValue) { checkWritePermission(); @@ -351,7 +352,7 @@ public class DefaultOperation extends IS /** * Returns the plan satisfied by the operation. * - * @return Plan satisfied by the operation, or {@code null}. + * @return plan satisfied by the operation, or {@code null}. */ @Override @XmlElement(name = "plan") @@ -362,7 +363,7 @@ public class DefaultOperation extends IS /** * Sets the plan satisfied by the operation. * - * @param newValue The new plan value. + * @param newValue the new plan value. */ public void setPlan(final Plan newValue) { checkWritePermission(); @@ -372,7 +373,7 @@ public class DefaultOperation extends IS /** * Returns the platform (or platforms) used in the operation. * - * @return Platforms used in the operation. + * @return platforms used in the operation. */ @Override @XmlElement(name = "platform") @@ -383,7 +384,7 @@ public class DefaultOperation extends IS /** * Sets the platform (or platforms) used in the operation. * - * @param newValues The new platforms values. + * @param newValues the new platforms values. */ public void setPlatforms(final Collection<? extends Platform> newValues) { platforms = writeCollection(newValues, platforms, Platform.class); @@ -392,7 +393,7 @@ public class DefaultOperation extends IS /** * Returns the record of an event occurring during an operation. * - * @return Record of an event occurring during an operation. + * @return record of an event occurring during an operation. */ @Override @XmlElement(name = "significantEvent") @@ -403,7 +404,7 @@ public class DefaultOperation extends IS /** * Sets the record of an event occurring during an operation. * - * @param newValues The new significant events value. + * @param newValues the new significant events value. */ public void setSignificantEvents(final Collection<? extends Event> newValues) { significantEvents = writeCollection(newValues, significantEvents, Event.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlan.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlan.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlan.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlan.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -47,6 +47,7 @@ import org.apache.sis.metadata.iso.ISOMe * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Plan_Type", propOrder = { "type", "status", @@ -97,7 +98,7 @@ public class DefaultPlan extends ISOMeta * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Plan) */ @@ -126,8 +127,8 @@ public class DefaultPlan extends ISOMeta * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultPlan castOrCopy(final Plan object) { @@ -141,7 +142,7 @@ public class DefaultPlan extends ISOMeta * Returns the manner of sampling geometry that the planner expects for collection of * objective data. {@code null} if unspecified. * - * @return Manner of sampling geometry, or {@code null}. + * @return manner of sampling geometry, or {@code null}. */ @Override @XmlElement(name = "type") @@ -153,7 +154,7 @@ public class DefaultPlan extends ISOMeta * Sets the manner of sampling geometry that the planner expects for collection of * objective data. * - * @param newValue The new type value. + * @param newValue the new type value. */ public void setType(final GeometryType newValue) { checkWritePermission(); @@ -163,7 +164,7 @@ public class DefaultPlan extends ISOMeta /** * Returns the current status of the plan (pending, completed, etc.) * - * @return Current status of the plan, or {@code null}. + * @return current status of the plan, or {@code null}. */ @Override @XmlElement(name = "status", required = true) @@ -174,7 +175,7 @@ public class DefaultPlan extends ISOMeta /** * Sets the current status of the plan (pending, completed, etc.) * - * @param newValue The new status value. + * @param newValue the new status value. */ public void setStatus(final Progress newValue) { checkWritePermission(); @@ -184,7 +185,7 @@ public class DefaultPlan extends ISOMeta /** * Returns the identification of authority requesting target collection. * - * @return Identification of authority requesting target collection, or {@code null}. + * @return identification of authority requesting target collection, or {@code null}. */ @Override @XmlElement(name = "citation", required = true) @@ -195,7 +196,7 @@ public class DefaultPlan extends ISOMeta /** * Sets the identification of authority requesting target collection. * - * @param newValue The new citation value. + * @param newValue the new citation value. */ public void setCitation(final Citation newValue) { checkWritePermission(); @@ -205,7 +206,7 @@ public class DefaultPlan extends ISOMeta /** * Returns the identification of the activity or activities that satisfy a plan. * - * @return Identification of the activity or activities. + * @return identification of the activity or activities. */ @Override @XmlElement(name = "operation") @@ -216,7 +217,7 @@ public class DefaultPlan extends ISOMeta /** * Sets the identification of the activity or activities that satisfy a plan. * - * @param newValues The new identifications of the activity. + * @param newValues the new identifications of the activity. */ public void setOperations(final Collection<? extends Operation> newValues) { operations = writeCollection(newValues, operations, Operation.class); @@ -225,7 +226,7 @@ public class DefaultPlan extends ISOMeta /** * Returns the requirement satisfied by the plan. * - * @return Requirement satisfied by the plan. + * @return requirement satisfied by the plan. */ @Override @XmlElement(name = "satisfiedRequirement") @@ -236,7 +237,7 @@ public class DefaultPlan extends ISOMeta /** * Sets the requirement satisfied by the plan. * - * @param newValues The new satisfied requirements. + * @param newValues the new satisfied requirements. */ public void setSatisfiedRequirements(final Collection<? extends Requirement> newValues) { satisfiedRequirements = writeCollection(newValues, satisfiedRequirements, Requirement.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatform.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatform.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatform.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -48,6 +48,7 @@ import org.apache.sis.internal.jaxb.NonM * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Platform_Type", propOrder = { "citation", "identifier", @@ -93,7 +94,7 @@ public class DefaultPlatform extends ISO * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Platform) */ @@ -122,8 +123,8 @@ public class DefaultPlatform extends ISO * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultPlatform castOrCopy(final Platform object) { @@ -136,7 +137,7 @@ public class DefaultPlatform extends ISO /** * Returns the source where information about the platform is described. {@code null} if unspecified. * - * @return Source where information about the platform is described, or {@code null}. + * @return source where information about the platform is described, or {@code null}. */ @Override @XmlElement(name = "citation") @@ -147,7 +148,7 @@ public class DefaultPlatform extends ISO /** * Sets the source where information about the platform is described. * - * @param newValue The new citation value. + * @param newValue the new citation value. */ public void setCitation(final Citation newValue) { checkWritePermission(); @@ -157,7 +158,7 @@ public class DefaultPlatform extends ISO /** * Returns the unique identification of the platform. * - * @return Unique identification of the platform, or {@code null}. + * @return unique identification of the platform, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -168,7 +169,7 @@ public class DefaultPlatform extends ISO /** * Sets the unique identification of the platform. * - * @param newValue The new identifier value. + * @param newValue the new identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -179,7 +180,7 @@ public class DefaultPlatform extends ISO /** * Gets the narrative description of the platform supporting the instrument. * - * @return Narrative description of the platform, or {@code null}. + * @return narrative description of the platform, or {@code null}. */ @Override @XmlElement(name = "description", required = true) @@ -190,7 +191,7 @@ public class DefaultPlatform extends ISO /** * Sets the narrative description of the platform supporting the instrument. * - * @param newValue The new description value. + * @param newValue the new description value. */ public void setDescription(final InternationalString newValue) { checkWritePermission(); @@ -205,7 +206,7 @@ public class DefaultPlatform extends ISO * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @return Organization responsible for building, launch, or operation of the platform. + * @return organization responsible for building, launch, or operation of the platform. */ @Override @XmlElement(name = "sponsor") @@ -221,7 +222,7 @@ public class DefaultPlatform extends ISO * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @param newValues The new sponsors values; + * @param newValues the new sponsors values; */ public void setSponsors(final Collection<? extends ResponsibleParty> newValues) { sponsors = writeCollection(newValues, sponsors, ResponsibleParty.class); @@ -230,7 +231,7 @@ public class DefaultPlatform extends ISO /** * Gets the instrument(s) mounted on a platform. * - * @return Instrument(s) mounted on a platform. + * @return instrument(s) mounted on a platform. */ @Override @XmlElement(name = "instrument", required = true) @@ -241,7 +242,7 @@ public class DefaultPlatform extends ISO /** * Sets the instrument(s) mounted on a platform. * - * @param newValues The new instruments values. + * @param newValues the new instruments values. */ public void setInstruments(final Collection<? extends Instrument> newValues) { instruments = writeCollection(newValues, instruments, Instrument.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatformPass.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatformPass.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatformPass.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultPlatformPass.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -46,6 +46,7 @@ import org.apache.sis.internal.jaxb.NonM * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_PlatformPass_Type", propOrder = { "identifier", "extent", @@ -79,7 +80,7 @@ public class DefaultPlatformPass extends * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(PlatformPass) */ @@ -106,8 +107,8 @@ public class DefaultPlatformPass extends * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultPlatformPass castOrCopy(final PlatformPass object) { @@ -120,7 +121,7 @@ public class DefaultPlatformPass extends /** * Returns the unique name of the pass. * - * @return Unique name of the pass, or {@code null}. + * @return unique name of the pass, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -131,7 +132,7 @@ public class DefaultPlatformPass extends /** * Sets the unique name of the pass. * - * @param newValue The new identifier value. + * @param newValue the new identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -142,7 +143,7 @@ public class DefaultPlatformPass extends /** * Returns the area covered by the pass. {@code null} if unspecified. * - * @return Area covered by the pass, or {@code null}. + * @return area covered by the pass, or {@code null}. */ @Override @XmlElement(name = "extent") @@ -153,7 +154,7 @@ public class DefaultPlatformPass extends /** * Sets the area covered by the pass. * - * @param newValue The new extent value. + * @param newValue the new extent value. */ public void setExtent(final Geometry newValue) { checkWritePermission(); @@ -163,7 +164,7 @@ public class DefaultPlatformPass extends /** * Returns the occurrence of one or more events for a pass. * - * @return Occurrence of one or more events for a pass. + * @return occurrence of one or more events for a pass. */ @Override @XmlElement(name = "relatedEvent") @@ -174,7 +175,7 @@ public class DefaultPlatformPass extends /** * Sets the occurrence of one or more events for a pass. * - * @param newValues The new related events values. + * @param newValues the new related events values. */ public void setRelatedEvents(final Collection<? extends Event> newValues) { relatedEvents = writeCollection(newValues, relatedEvents, Event.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequestedDate.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequestedDate.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequestedDate.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequestedDate.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -45,6 +45,7 @@ import static org.apache.sis.internal.me * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_RequestedDate_Type", propOrder = { "requestedDateOfCollection", "latestAcceptableDate" @@ -79,7 +80,7 @@ public class DefaultRequestedDate extend * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(RequestedDate) */ @@ -105,8 +106,8 @@ public class DefaultRequestedDate extend * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultRequestedDate castOrCopy(final RequestedDate object) { @@ -119,7 +120,7 @@ public class DefaultRequestedDate extend /** * Returns the preferred date and time of collection. * - * @return Preferred date and time, or {@code null}. + * @return preferred date and time, or {@code null}. */ @Override @XmlElement(name = "requestedDateOfCollection", required = true) @@ -130,7 +131,7 @@ public class DefaultRequestedDate extend /** * Sets the preferred date and time of collection. * - * @param newValue The new requested date of collection value. + * @param newValue the new requested date of collection value. */ public void setRequestedDateOfCollection(final Date newValue) { checkWritePermission(); @@ -140,7 +141,7 @@ public class DefaultRequestedDate extend /** * Returns the latest date and time collection must be completed. * - * @return Latest date and time, or {@code null}. + * @return latest date and time, or {@code null}. */ @Override @XmlElement(name = "latestAcceptableDate", required = true) @@ -151,7 +152,7 @@ public class DefaultRequestedDate extend /** * Sets the latest date and time collection must be completed. * - * @param newValue The new latest acceptable data value. + * @param newValue the new latest acceptable data value. */ public void setLatestAcceptableDate(final Date newValue) { checkWritePermission(); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequirement.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequirement.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequirement.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/DefaultRequirement.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -53,6 +53,7 @@ import static org.apache.sis.internal.me * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "MI_Requirement_Type", propOrder = { "citation", "identifier", @@ -117,7 +118,7 @@ public class DefaultRequirement extends * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Requirement) */ @@ -149,8 +150,8 @@ public class DefaultRequirement extends * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultRequirement castOrCopy(final Requirement object) { @@ -164,7 +165,7 @@ public class DefaultRequirement extends * Returns the identification of reference or guidance material for the requirement. * {@code null} if unspecified. * - * @return Identification of reference or guidance material, or {@code null}. + * @return identification of reference or guidance material, or {@code null}. */ @Override @XmlElement(name = "citation") @@ -175,7 +176,7 @@ public class DefaultRequirement extends /** * Sets the identification of reference or guidance material for the requirement. * - * @param newValue The new citation value. + * @param newValue the new citation value. */ public void setCitation(final Citation newValue) { checkWritePermission(); @@ -185,7 +186,7 @@ public class DefaultRequirement extends /** * Returns the unique name, or code, for the requirement. * - * @return Unique name or code, or {@code null}. + * @return unique name or code, or {@code null}. */ @Override @XmlElement(name = "identifier", required = true) @@ -196,7 +197,7 @@ public class DefaultRequirement extends /** * Sets the unique name, or code, for the requirement. * - * @param newValue The new identifier value. + * @param newValue the new identifier value. */ public void setIdentifier(final Identifier newValue) { checkWritePermission(); @@ -212,7 +213,7 @@ public class DefaultRequirement extends * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @return Origin of requirement. + * @return origin of requirement. */ @Override @XmlElement(name = "requestor", required = true) @@ -228,7 +229,7 @@ public class DefaultRequirement extends * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @param newValues The new requestors values. + * @param newValues the new requestors values. */ public void setRequestors(final Collection<? extends ResponsibleParty> newValues) { requestors = writeCollection(newValues, requestors, ResponsibleParty.class); @@ -242,7 +243,7 @@ public class DefaultRequirement extends * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @return Person(s), or body(ies), to receive results. + * @return person(s), or body(ies), to receive results. */ @Override @XmlElement(name = "recipient", required = true) @@ -258,7 +259,7 @@ public class DefaultRequirement extends * This change will be tentatively applied in GeoAPI 4.0. * </div> * - * @param newValues The new recipients values. + * @param newValues the new recipients values. */ public void setRecipients(final Collection<? extends ResponsibleParty> newValues) { recipients = writeCollection(newValues, recipients, ResponsibleParty.class); @@ -267,7 +268,7 @@ public class DefaultRequirement extends /** * Returns the relative ordered importance, or urgency, of the requirement. * - * @return Relative ordered importance, or urgency, or {@code null}. + * @return relative ordered importance, or urgency, or {@code null}. */ @Override @XmlElement(name = "priority", required = true) @@ -278,7 +279,7 @@ public class DefaultRequirement extends /** * Sets the relative ordered importance, or urgency, of the requirement. * - * @param newValue The new priority value. + * @param newValue the new priority value. */ public void setPriority(final Priority newValue) { checkWritePermission(); @@ -288,7 +289,7 @@ public class DefaultRequirement extends /** * Returns the required or preferred acquisition date and time. * - * @return Required or preferred acquisition date and time, or {@code null}. + * @return required or preferred acquisition date and time, or {@code null}. */ @Override @XmlElement(name = "requestedDate", required = true) @@ -299,7 +300,7 @@ public class DefaultRequirement extends /** * Sets the required or preferred acquisition date and time. * - * @param newValue The new requested date value. + * @param newValue the new requested date value. */ public void setRequestedDate(final RequestedDate newValue) { checkWritePermission(); @@ -309,7 +310,7 @@ public class DefaultRequirement extends /** * Returns the date and time after which collection is no longer valid. * - * @return Date and time after which collection is no longer valid, or {@code null}. + * @return date and time after which collection is no longer valid, or {@code null}. */ @Override @XmlElement(name = "expiryDate", required = true) @@ -320,7 +321,7 @@ public class DefaultRequirement extends /** * Sets the date and time after which collection is no longer valid. * - * @param newValue The new expiry date. + * @param newValue the new expiry date. */ public void setExpiryDate(final Date newValue) { checkWritePermission(); @@ -330,7 +331,7 @@ public class DefaultRequirement extends /** * Returns the plan that identifies solution to satisfy the requirement. * - * @return Plan that identifies solution to satisfy the requirement. + * @return plan that identifies solution to satisfy the requirement. */ @Override @XmlElement(name = "satisfiedPlan") @@ -339,7 +340,7 @@ public class DefaultRequirement extends } /** - * @param newValues The new satisfied plans values. + * @param newValues the new satisfied plans values. */ public void setSatisfiedPlans(final Collection<? extends Plan> newValues) { satisfiedPlans = writeCollection(newValues, satisfiedPlans, Plan.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/AbstractParty.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/AbstractParty.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/AbstractParty.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/AbstractParty.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -59,6 +59,7 @@ import static org.opengis.annotation.Spe * @version 0.5 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "AbstractCI_Party_Type", propOrder = { "name", "contactInfo" @@ -94,8 +95,8 @@ public class AbstractParty extends ISOMe /** * Constructs a party initialized with the specified name and contact information. * - * @param name Name of the party, or {@code null} if none. - * @param contactInfo Contact information for the party, or {@code null} if none. + * @param name name of the party, or {@code null} if none. + * @param contactInfo contact information for the party, or {@code null} if none. */ public AbstractParty(final CharSequence name, final Contact contactInfo) { this.name = Types.toInternationalString(name); @@ -107,7 +108,7 @@ public class AbstractParty extends ISOMe * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. */ public AbstractParty(final AbstractParty object) { super(object); @@ -120,7 +121,7 @@ public class AbstractParty extends ISOMe /** * Return the name of the party. * - * @return Name of the party. + * @return name of the party. */ @XmlElement(name = "name") @UML(identifier="name", obligation=CONDITIONAL, specification=ISO_19115) @@ -131,7 +132,7 @@ public class AbstractParty extends ISOMe /** * Sets the name of the party. * - * @param newValue The new name of the party. + * @param newValue the new name of the party. */ public void setName(final InternationalString newValue) { checkWritePermission(); @@ -141,7 +142,7 @@ public class AbstractParty extends ISOMe /** * Returns the contact information for the party. * - * @return Contact information for the party. + * @return contact information for the party. */ @XmlElement(name = "contactInfo") @UML(identifier="contactInfo", obligation=OPTIONAL, specification=ISO_19115) @@ -152,7 +153,7 @@ public class AbstractParty extends ISOMe /** * Sets the contact information for the party. * - * @param newValues The new contact information for the party. + * @param newValues the new contact information for the party. */ public void setContactInfo(final Collection<? extends Contact> newValues) { contactInfo = writeCollection(newValues, contactInfo, Contact.class); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/Citations.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -18,7 +18,7 @@ package org.apache.sis.metadata.iso.cita import java.util.List; import org.opengis.metadata.citation.Citation; -import org.opengis.referencing.IdentifiedObject; // For javadoc +import org.opengis.referencing.IdentifiedObject; // For javadoc import org.apache.sis.util.Static; import org.apache.sis.util.CharSequences; import org.apache.sis.xml.IdentifierSpace; @@ -29,7 +29,7 @@ import org.apache.sis.internal.simple.Ci import org.apache.sis.internal.jaxb.NonMarshalledAuthority; import org.apache.sis.internal.system.Modules; import org.apache.sis.internal.system.SystemListener; -import org.apache.sis.metadata.iso.DefaultIdentifier; // For javadoc +import org.apache.sis.metadata.iso.DefaultIdentifier; // For javadoc import static org.apache.sis.internal.util.Citations.equalsFiltered; @@ -488,8 +488,8 @@ public final class Citations extends Sta * <li>Otherwise, a new citation is created with the specified name as the title.</li> * </ul> * - * @param identifier The citation title (or alternate title), or {@code null}. - * @return A citation using the specified name, or {@code null} if the given title is null or empty. + * @param identifier the citation title (or alternate title), or {@code null}. + * @return a citation using the specified name, or {@code null} if the given title is null or empty. */ public static Citation fromName(String identifier) { if (identifier == null || ((identifier = CharSequences.trimWhitespaces(identifier)).isEmpty())) { @@ -500,7 +500,7 @@ public final class Citations extends Sta return citation; } } - if (equalsFiltered(identifier, "OGP")) { // Old name of "IOGP" organization. + if (equalsFiltered(identifier, "OGP")) { // Old name of "IOGP" organization. return IOGP; } if (equalsFiltered(identifier, Constants.CRS)) { @@ -520,8 +520,8 @@ public final class Citations extends Sta * and ignores every character which is not a {@linkplain Character#isLetterOrDigit(int) * letter or a digit}. The titles ordering is not significant. * - * @param c1 The first citation to compare, or {@code null}. - * @param c2 the second citation to compare, or {@code null}. + * @param c1 the first citation to compare, or {@code null}. + * @param c2 the second citation to compare, or {@code null}. * @return {@code true} if both arguments are non-null, and at least one title or alternate title matches. */ public static boolean titleMatches(final Citation c1, final Citation c2) { @@ -534,8 +534,8 @@ public final class Citations extends Sta * matches the given string. The comparison is case-insensitive and ignores every character * which is not a {@linkplain Character#isLetterOrDigit(int) letter or a digit}. * - * @param citation The citation to check for, or {@code null}. - * @param title The title or alternate title to compare, or {@code null}. + * @param citation the citation to check for, or {@code null}. + * @param title the title or alternate title to compare, or {@code null}. * @return {@code true} if both arguments are non-null, and the title or an alternate * title matches the given string. */ @@ -556,8 +556,8 @@ public final class Citations extends Sta * method. This fallback exists for compatibility with client codes using the citation * {@linkplain DefaultCitation#getTitle() titles} without identifiers.</p> * - * @param c1 The first citation to compare, or {@code null}. - * @param c2 the second citation to compare, or {@code null}. + * @param c1 the first citation to compare, or {@code null}. + * @param c2 the second citation to compare, or {@code null}. * @return {@code true} if both arguments are non-null, and at least one identifier matches. */ public static boolean identifierMatches(final Citation c1, final Citation c2) { @@ -577,8 +577,8 @@ public final class Citations extends Sta * {@linkplain DefaultCitation#getAlternateTitles() alternate titles} (often abbreviations) * without identifiers.</p> * - * @param citation The citation to check for, or {@code null}. - * @param identifier The identifier to compare, or {@code null}. + * @param citation the citation to check for, or {@code null}. + * @param identifier the identifier to compare, or {@code null}. * @return {@code true} if both arguments are non-null, and an identifier matches the given string. */ public static boolean identifierMatches(final Citation citation, final String identifier) { @@ -638,8 +638,8 @@ public final class Citations extends Sta * The returned string is useful when an "identifier-like" string is desired for display or information purpose, * but does not need to be a strictly valid identifier. * - * @param citation The citation for which to get the identifier, or {@code null}. - * @return A non-empty identifier for the given citation without leading or trailing whitespaces, + * @param citation the citation for which to get the identifier, or {@code null}. + * @return a non-empty identifier for the given citation without leading or trailing whitespaces, * or {@code null} if the given citation is null or does not declare any identifier or title. */ public static String getIdentifier(final Citation citation) { @@ -679,8 +679,8 @@ public final class Citations extends Sta * <li>{@code ⁔}</li> * </ul></div> * - * @param citation The citation for which to get the Unicode identifier, or {@code null}. - * @return A non-empty Unicode identifier for the given citation without leading or trailing whitespaces, + * @param citation the citation for which to get the Unicode identifier, or {@code null}. + * @return a non-empty Unicode identifier for the given citation without leading or trailing whitespaces, * or {@code null} if the given citation is null or does not have any Unicode identifier or title. * * @see org.apache.sis.metadata.iso.ImmutableIdentifier Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultAddress.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultAddress.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultAddress.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultAddress.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -44,6 +44,7 @@ import org.apache.sis.metadata.iso.ISOMe * @version 0.3 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "CI_Address_Type", propOrder = { "deliveryPoints", "city", @@ -100,7 +101,7 @@ public class DefaultAddress extends ISOM * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Address) */ @@ -130,8 +131,8 @@ public class DefaultAddress extends ISOM * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultAddress castOrCopy(final Address object) { @@ -144,7 +145,7 @@ public class DefaultAddress extends ISOM /** * Return the state, province of the location. * - * @return State, province of the location, or {@code null}. + * @return state, province of the location, or {@code null}. */ @Override @XmlElement(name = "administrativeArea") @@ -155,7 +156,7 @@ public class DefaultAddress extends ISOM /** * Sets the state, province of the location. * - * @param newValue The new administrative area. + * @param newValue the new administrative area. */ public void setAdministrativeArea(final InternationalString newValue) { checkWritePermission(); @@ -165,7 +166,7 @@ public class DefaultAddress extends ISOM /** * Returns the city of the location. * - * @return The city of the location, or {@code null}. + * @return the city of the location, or {@code null}. */ @Override @XmlElement(name = "city") @@ -176,7 +177,7 @@ public class DefaultAddress extends ISOM /** * Sets the city of the location. * - * @param newValue The new city, or {@code null} if none. + * @param newValue the new city, or {@code null} if none. */ public void setCity(final InternationalString newValue) { checkWritePermission(); @@ -186,7 +187,7 @@ public class DefaultAddress extends ISOM /** * Returns the country of the physical address. * - * @return Country of the physical address, or {@code null}. + * @return country of the physical address, or {@code null}. */ @Override @XmlElement(name = "country") @@ -197,7 +198,7 @@ public class DefaultAddress extends ISOM /** * Sets the country of the physical address. * - * @param newValue The new country, or {@code null} if none. + * @param newValue the new country, or {@code null} if none. */ public void setCountry(final InternationalString newValue) { checkWritePermission(); @@ -212,7 +213,7 @@ public class DefaultAddress extends ISOM * {@code Collection<? extends InternationalString>} in GeoAPI 4.0. * </div> * - * @return Address line for the location. + * @return address line for the location. */ @Override @XmlElement(name = "deliveryPoint") @@ -228,7 +229,7 @@ public class DefaultAddress extends ISOM * {@code Collection<? extends InternationalString>} in GeoAPI 4.0. * </div> * - * @param newValues The new delivery points, or {@code null} if none. + * @param newValues the new delivery points, or {@code null} if none. */ public void setDeliveryPoints(final Collection<? extends String> newValues) { deliveryPoints = writeCollection(newValues, deliveryPoints, String.class); @@ -237,7 +238,7 @@ public class DefaultAddress extends ISOM /** * Returns the address of the electronic mailbox of the responsible organization or individual. * - * @return Address of the electronic mailbox of the responsible organization or individual. + * @return address of the electronic mailbox of the responsible organization or individual. */ @Override @XmlElement(name = "electronicMailAddress") @@ -248,7 +249,7 @@ public class DefaultAddress extends ISOM /** * Sets the address of the electronic mailbox of the responsible organization or individual. * - * @param newValues The new electronic mail addresses, or {@code null} if none. + * @param newValues the new electronic mail addresses, or {@code null} if none. */ public void setElectronicMailAddresses(final Collection<? extends String> newValues) { electronicMailAddresses = writeCollection(newValues, electronicMailAddresses, String.class); @@ -268,7 +269,7 @@ public class DefaultAddress extends ISOM /** * Sets ZIP or other postal code. * - * @param newValue The new postal code, or {@code null} if none. + * @param newValue the new postal code, or {@code null} if none. */ public void setPostalCode(final String newValue) { checkWritePermission(); Modified: sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java [UTF-8] (original) +++ sis/trunk/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/DefaultCitation.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -69,6 +69,7 @@ import static org.apache.sis.internal.me * @version 0.7 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // ModifiableMetadata needs shallow clones. @XmlType(name = "CI_Citation_Type", propOrder = { "title", "alternateTitles", @@ -170,8 +171,8 @@ public class DefaultCitation extends ISO /** * Constructs a citation with the specified title. * - * @param title The title as a {@link String} or an {@link InternationalString} object, - * or {@code null} if none. + * @param title the title as a {@link String} or an {@link InternationalString} object, + * or {@code null} if none. */ public DefaultCitation(final CharSequence title) { this.title = Types.toInternationalString(title); @@ -182,7 +183,7 @@ public class DefaultCitation extends ISO * This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the * given object are not recursively copied. * - * @param object The metadata to copy values from, or {@code null} if none. + * @param object the metadata to copy values from, or {@code null} if none. * * @see #castOrCopy(Citation) */ @@ -229,8 +230,8 @@ public class DefaultCitation extends ISO * metadata contained in the given object are not recursively copied.</li> * </ul> * - * @param object The object to get as a SIS implementation, or {@code null} if none. - * @return A SIS implementation containing the values of the given object (may be the + * @param object the object to get as a SIS implementation, or {@code null} if none. + * @return a SIS implementation containing the values of the given object (may be the * given object itself), or {@code null} if the argument was null. */ public static DefaultCitation castOrCopy(final Citation object) { @@ -243,7 +244,7 @@ public class DefaultCitation extends ISO /** * Returns the name by which the cited resource is known. * - * @return The cited resource name, or {@code null}. + * @return the cited resource name, or {@code null}. */ @Override @XmlElement(name = "title", required = true) @@ -254,7 +255,7 @@ public class DefaultCitation extends ISO /** * Sets the name by which the cited resource is known. * - * @param newValue The new title, or {@code null} if none. + * @param newValue the new title, or {@code null} if none. */ public void setTitle(final InternationalString newValue) { checkWritePermission(); @@ -266,7 +267,7 @@ public class DefaultCitation extends ISO * * <div class="note"><b>Example:</b> "DCW" as an alternative title for "Digital Chart of the World".</div> * - * @return Other names for the resource, or an empty collection if none. + * @return other names for the resource, or an empty collection if none. */ @Override @XmlElement(name = "alternateTitle") @@ -277,7 +278,7 @@ public class DefaultCitation extends ISO /** * Sets the short name or other language name by which the cited information is known. * - * @param newValues The new alternate titles, or {@code null} if none. + * @param newValues the new alternate titles, or {@code null} if none. */ public void setAlternateTitles(final Collection<? extends InternationalString> newValues) { alternateTitles = writeCollection(newValues, alternateTitles, InternationalString.class); @@ -286,7 +287,7 @@ public class DefaultCitation extends ISO /** * Returns the reference date for the cited resource. * - * @return The reference date. + * @return the reference date. */ @Override @XmlElement(name = "date", required = true) @@ -297,7 +298,7 @@ public class DefaultCitation extends ISO /** * Sets the reference date for the cited resource. * - * @param newValues The new dates, or {@code null} if none. + * @param newValues the new dates, or {@code null} if none. */ public void setDates(final Collection<? extends CitationDate> newValues) { dates = writeCollection(newValues, dates, CitationDate.class); @@ -306,7 +307,7 @@ public class DefaultCitation extends ISO /** * Returns the version of the cited resource. * - * @return The version, or {@code null} if none. + * @return the version, or {@code null} if none. */ @Override @XmlElement(name = "edition") @@ -317,7 +318,7 @@ public class DefaultCitation extends ISO /** * Sets the version of the cited resource. * - * @param newValue The new edition, or {@code null} if none. + * @param newValue the new edition, or {@code null} if none. */ public void setEdition(final InternationalString newValue) { checkWritePermission(); @@ -327,7 +328,7 @@ public class DefaultCitation extends ISO /** * Returns the date of the edition. * - * @return The edition date, or {@code null} if none. + * @return the edition date, or {@code null} if none. */ @Override @XmlElement(name = "editionDate") @@ -338,7 +339,7 @@ public class DefaultCitation extends ISO /** * Sets the date of the edition. * - * @param newValue The new edition date, or {@code null} if none. + * @param newValue the new edition date, or {@code null} if none. */ public void setEditionDate(final Date newValue) { checkWritePermission(); @@ -360,7 +361,7 @@ public class DefaultCitation extends ISO * The {@code <gmd:identifier>} element marshalled to XML will exclude all the above cited identifiers, * for ISO 19139 compliance. Those identifiers will appear in other XML elements or attributes.</div> * - * @return The identifiers, or an empty collection if none. + * @return the identifiers, or an empty collection if none. * * @see #getISBN() * @see #getISSN() @@ -380,7 +381,7 @@ public class DefaultCitation extends ISO * {@linkplain #getISBN() ISBN} and {@linkplain #getISSN() ISSN} codes are not affected by this method, unless * they are explicitely provided in the given collection.</p> * - * @param newValues The new identifiers, or {@code null} if none. + * @param newValues the new identifiers, or {@code null} if none. * * @see #setISBN(String) * @see #setISSN(String) @@ -399,7 +400,7 @@ public class DefaultCitation extends ISO * This change may be applied in GeoAPI 4.0. * </div> * - * @return The individual or organization that is responsible, or an empty collection if none. + * @return the individual or organization that is responsible, or an empty collection if none. */ @Override @XmlElement(name = "citedResponsibleParty") @@ -416,7 +417,7 @@ public class DefaultCitation extends ISO * This change may be applied in GeoAPI 4.0. * </div> * - * @param newValues The new cited responsible parties, or {@code null} if none. + * @param newValues the new cited responsible parties, or {@code null} if none. */ public void setCitedResponsibleParties(final Collection<? extends ResponsibleParty> newValues) { citedResponsibleParties = writeCollection(newValues, citedResponsibleParties, ResponsibleParty.class); @@ -425,7 +426,7 @@ public class DefaultCitation extends ISO /** * Returns the mode in which the resource is represented. * - * @return The presentation modes, or an empty collection if none. + * @return the presentation modes, or an empty collection if none. */ @Override @XmlElement(name = "presentationForm") @@ -436,7 +437,7 @@ public class DefaultCitation extends ISO /** * Sets the mode in which the resource is represented. * - * @param newValues The new presentation form, or {@code null} if none. + * @param newValues the new presentation form, or {@code null} if none. */ public void setPresentationForms(final Collection<? extends PresentationForm> newValues) { presentationForms = writeCollection(newValues, presentationForms, PresentationForm.class); @@ -445,7 +446,7 @@ public class DefaultCitation extends ISO /** * Returns the information about the series, or aggregate dataset, of which the dataset is a part. * - * @return The series of which the dataset is a part, or {@code null} if none. + * @return the series of which the dataset is a part, or {@code null} if none. */ @Override @XmlElement(name = "series") @@ -456,7 +457,7 @@ public class DefaultCitation extends ISO /** * Sets the information about the series, or aggregate dataset, of which the dataset is a part. * - * @param newValue The new series. + * @param newValue the new series. */ public void setSeries(final Series newValue) { checkWritePermission(); @@ -471,7 +472,7 @@ public class DefaultCitation extends ISO * This change may be applied in GeoAPI 4.0. * </div> * - * @return Other details, or {@code null} if none. + * @return other details, or {@code null} if none. */ @Override @XmlElement(name = "otherCitationDetails") @@ -497,7 +498,7 @@ public class DefaultCitation extends ISO /** * Returns the common title with holdings note. * - * @return The common title, or {@code null} if none. + * @return the common title, or {@code null} if none. * * @deprecated Removed as of ISO 19115:2014. */ @@ -512,7 +513,7 @@ public class DefaultCitation extends ISO * Sets the common title with holdings note. This title identifies elements of a series collectively, * combined with information about what volumes are available at the source cited. * - * @param newValue The new collective title, or {@code null} if none. + * @param newValue the new collective title, or {@code null} if none. * * @deprecated Removed as of ISO 19115:2014. */ @@ -530,7 +531,7 @@ public class DefaultCitation extends ISO * return getIdentifierMap().getSpecialized(Citations.ISBN); * } * - * @return The ISBN, or {@code null} if none. + * @return the ISBN, or {@code null} if none. * * @see #getIdentifiers() * @see Citations#ISBN @@ -549,7 +550,7 @@ public class DefaultCitation extends ISO * getIdentifierMap().putSpecialized(Citations.ISBN, newValue); * } * - * @param newValue The new ISBN, or {@code null} if none. + * @param newValue the new ISBN, or {@code null} if none. * * @see #setIdentifiers(Collection) * @see Citations#ISBN @@ -569,7 +570,7 @@ public class DefaultCitation extends ISO * return getIdentifierMap().getSpecialized(Citations.ISSN); * } * - * @return The ISSN, or {@code null} if none. + * @return the ISSN, or {@code null} if none. * * @see #getIdentifiers() * @see Citations#ISSN @@ -588,7 +589,7 @@ public class DefaultCitation extends ISO * getIdentifierMap().putSpecialized(Citations.ISSN, newValue); * } * - * @param newValue The new ISSN. + * @param newValue the new ISSN. * * @see #setIdentifiers(Collection) * @see Citations#ISSN @@ -603,7 +604,7 @@ public class DefaultCitation extends ISO /** * Returns online references to the cited resource. * - * @return Online references to the cited resource, or an empty collection if there is none. + * @return online references to the cited resource, or an empty collection if there is none. * * @since 0.5 */ @@ -616,7 +617,7 @@ public class DefaultCitation extends ISO /** * Sets online references to the cited resource. * - * @param newValues The new online references to the cited resource. + * @param newValues the new online references to the cited resource. * * @since 0.5 */ @@ -627,7 +628,7 @@ public class DefaultCitation extends ISO /** * Returns citation graphics or logo for cited party. * - * @return Graphics or logo for cited party, or an empty collection if there is none. + * @return graphics or logo for cited party, or an empty collection if there is none. * * @since 0.5 */ @@ -640,7 +641,7 @@ public class DefaultCitation extends ISO /** * Sets citation graphics or logo for cited party. * - * @param newValues The new citation graphics or logo for cited party. + * @param newValues the new citation graphics or logo for cited party. * * @since 0.5 */
