Skip to content

Commit

Permalink
Merge pull request #44 from rovarga/javadoc-fixes
Browse files Browse the repository at this point in the history
Fix mal-fomatted javadoc
  • Loading branch information
semancik committed Sep 4, 2017
2 parents 29a9c75 + b199cf9 commit 0ef8b5c
Show file tree
Hide file tree
Showing 53 changed files with 409 additions and 463 deletions.
24 changes: 12 additions & 12 deletions infra/prism/src/main/java/com/evolveum/midpoint/prism/Item.java
Expand Up @@ -35,7 +35,7 @@

/**
* Item is a common abstraction of Property and PropertyContainer.
* <p/>
* <p>
* This is supposed to be a superclass for all items. Items are things
* that can appear in property containers, which generally means only a property
* and property container itself. Therefore this is in fact superclass for those
Expand Down Expand Up @@ -92,7 +92,7 @@ public abstract class Item<V extends PrismValue, D extends ItemDefinition> imple

/**
* Returns applicable property definition.
* <p/>
* <p>
* May return null if no definition is applicable or the definition is not
* know.
*
Expand All @@ -109,11 +109,11 @@ public boolean hasCompleteDefinition() {

/**
* Returns the name of the property.
* <p/>
* <p>
* The name is a QName. It uniquely defines a property.
* <p/>
* <p>
* The name may be null, but such a property will not work.
* <p/>
* <p>
* The name is the QName of XML element in the XML representation.
*
* @return property name
Expand All @@ -125,11 +125,11 @@ public QName getElementName() {

/**
* Sets the name of the property.
* <p/>
* <p>
* The name is a QName. It uniquely defines a property.
* <p/>
* <p>
* The name may be null, but such a property will not work.
* <p/>
* <p>
* The name is the QName of XML element in the XML representation.
*
* @param elementName the name to set
Expand All @@ -152,9 +152,9 @@ public void setDefinition(D definition) {

/**
* Returns a display name for the property type.
* <p/>
* <p>
* Returns null if the display name cannot be determined.
* <p/>
* <p>
* The display name is fetched from the definition. If no definition
* (schema) is available, the display name will not be returned.
*
Expand All @@ -166,9 +166,9 @@ public String getDisplayName() {

/**
* Returns help message defined for the property type.
* <p/>
* <p>
* Returns null if the help message cannot be determined.
* <p/>
* <p>
* The help message is fetched from the definition. If no definition
* (schema) is available, the help message will not be returned.
*
Expand Down
Expand Up @@ -97,8 +97,8 @@ public interface ItemDefinition<I extends Item> extends Definition {
boolean canAdd();

/**
* Returns the name of an element this one can be substituted for (e.g. c:user -> c:object,
* s:pipeline -> s:expression, etc). EXPERIMENTAL
* Returns the name of an element this one can be substituted for (e.g. c:user -&gt; c:object,
* s:pipeline -&gt; s:expression, etc). EXPERIMENTAL
*/
QName getSubstitutionHead();

Expand Down
Expand Up @@ -128,7 +128,7 @@ public void setMinOccurs(int minOccurs) {

/**
* Return the number of maximal value occurrences.
* <p/>
* <p>
* Any negative number means "unbounded".
*
* @return the maxOccurs
Expand Down
Expand Up @@ -327,7 +327,7 @@ public void trim() {

/**
* Returns applicable property container definition.
* <p/>
* <p>
* May return null if no definition is applicable or the definition is not
* know.
*
Expand Down
Expand Up @@ -40,21 +40,21 @@

/**
* Definition of a property container.
* <p/>
* <p>
* Property container groups properties into logical blocks. The reason for
* grouping may be as simple as better understandability of data structure. But
* the group usually means different meaning, source or structure of the data.
* For example, the property container is frequently used to hold properties
* that are dynamic, not fixed by a static schema. Such grouping also naturally
* translates to XML and helps to "quarantine" such properties to avoid Unique
* Particle Attribute problems.
* <p/>
* <p>
* Property Container contains a set of (potentially multi-valued) properties.
* The order of properties is not significant, regardless of the fact that it
* may be fixed in the XML representation. In the XML representation, each
* element inside Property Container must be either Property or a Property
* Container.
* <p/>
* <p>
* This class represents schema definition for property container. See
* {@link Definition} for more details.
*
Expand Down Expand Up @@ -247,10 +247,10 @@ public <ID extends ItemDefinition> ID findNamedItemDefinition(@NotNull QName fir

/**
* Returns set of property definitions.
* <p/>
* <p>
* WARNING: This may return definitions from the associated complex type.
* Therefore changing the returned set may influence also the complex type definition.
* <p/>
* <p>
* The set contains all property definitions of all types that were parsed.
* Order of definitions is insignificant.
*
Expand All @@ -268,10 +268,10 @@ public List<? extends ItemDefinition> getDefinitions() {

/**
* Returns set of property definitions.
* <p/>
* <p>
* The set contains all property definitions of all types that were parsed.
* Order of definitions is insignificant.
* <p/>
* <p>
* The returned set is immutable! All changes may be lost.
*
* @return set of definitions
Expand Down Expand Up @@ -353,7 +353,7 @@ public void replaceDefinition(QName itemName, ItemDefinition newDefinition) {

/**
* Creates new instance of property definition and adds it to the container.
* <p/>
* <p>
* This is the preferred method of creating a new definition.
*
* @param name name of the property (element name)
Expand All @@ -378,7 +378,7 @@ private void addDefinition(ItemDefinition itemDef) {

/**
* Creates new instance of property definition and adds it to the container.
* <p/>
* <p>
* This is the preferred method of creating a new definition.
*
* @param name name of the property (element name)
Expand Down Expand Up @@ -407,7 +407,7 @@ public PrismPropertyDefinition createPropertyDefinition(QName name) {

/**
* Creates new instance of property definition and adds it to the container.
* <p/>
* <p>
* This is the preferred method of creating a new definition.
*
* @param localName name of the property (element name) relative to the schema namespace
Expand All @@ -421,7 +421,7 @@ public PrismPropertyDefinition createPropertyDefinition(String localName, QName

/**
* Creates new instance of property definition and adds it to the container.
* <p/>
* <p>
* This is the preferred method of creating a new definition.
*
* @param localName name of the property (element name) relative to the schema namespace
Expand All @@ -436,7 +436,7 @@ public PrismPropertyDefinition createPropertyDefinition(String localName, String

/**
* Creates new instance of property definition and adds it to the container.
* <p/>
* <p>
* This is the preferred method of creating a new definition.
*
* @param localName name of the property (element name) relative to the schema namespace
Expand Down
Expand Up @@ -110,10 +110,10 @@ public PrismContext getPrismContextLocal() {

/**
* Returns a set of items that the property container contains. The items may be properties or inner property containers.
* <p/>
* <p>
* The set may be null. In case there are no properties an empty set is
* returned.
* <p/>
* <p>
* Returned set is mutable. Live object is returned.
*
* @return set of items that the property container contains.
Expand Down Expand Up @@ -168,10 +168,10 @@ public Item<?,?> getPreviousItem(Item<?,?> referenceItem) {

/**
* Returns a set of properties that the property container contains.
* <p/>
* <p>
* The set must not be null. In case there are no properties an empty set is
* returned.
* <p/>
* <p>
* Returned set is immutable! Any change to it will be ignored.
*
* @return set of properties that the property container contains.
Expand Down Expand Up @@ -542,7 +542,7 @@ public <X> PrismProperty<X> findProperty(ItemPath propertyPath) {

/**
* Finds a specific property in the container by definition.
* <p/>
* <p>
* Returns null if nothing is found.
*
* @param propertyDefinition property definition to find.
Expand Down
Expand Up @@ -232,7 +232,6 @@ <C extends Containerable, O extends Objectable> void adopt(PrismContainerValue<C
* will be thrown as run-time exception.
* @param clazz Static type of the object to be created.
* @return New PrismObject's objectable content.
* @throws SchemaException If a definition for the given class couldn't be found.
*/
@NotNull
<O extends Objectable> O createKnownObjectable(@NotNull Class<O> clazz);
Expand Down
Expand Up @@ -43,21 +43,21 @@
* Property is a specific characteristic of an object. It may be considered
* object "attribute" or "field". For example User has fullName property that
* contains string value of user's full name.
* <p/>
* <p>
* Properties may be single-valued or multi-valued
* <p/>
* <p>
* Properties may contain primitive types or complex types (defined by XSD
* schema)
* <p/>
* <p>
* Property values are unordered, implementation may change the order of values
* <p/>
* <p>
* Duplicate values of properties should be silently removed by implementations,
* but clients must be able tolerate presence of duplicate values.
* <p/>
* <p>
* Operations that modify the objects work with the granularity of properties.
* They add/remove/replace the values of properties, but do not "see" inside the
* property.
* <p/>
* <p>
* Property is mutable.
*
* @author Radovan Semancik
Expand All @@ -84,7 +84,7 @@ protected PrismProperty(QName name, PrismPropertyDefinition<T> definition, Prism

/**
* Returns applicable property definition.
* <p/>
* <p>
* May return null if no definition is applicable or the definition is not
* know.
*
Expand Down
Expand Up @@ -35,7 +35,7 @@ public interface PrismPropertyDefinition<T> extends ItemDefinition<PrismProperty

/**
* Returns QName of the property value type.
* <p/>
* <p>
* The returned type is either XSD simple type or complex type. It may not
* be defined in the same schema (especially if it is standard XSD simple
* type).
Expand Down
Expand Up @@ -27,28 +27,28 @@

/**
* Property Definition.
* <p/>
* <p>
* Property is a basic unit of information in midPoint. This class provides
* definition of property type, multiplicity and so on.
* <p/>
* <p>
* Property is a specific characteristic of an object. It may be considered
* object "attribute" or "field". For example User has fullName property that
* contains string value of user's full name.
* <p/>
* <p>
* Properties may be single-valued or multi-valued
* <p/>
* <p>
* Properties may contain primitive types or complex types (defined by XSD
* schema)
* <p/>
* <p>
* Property values are unordered, implementation may change the order of values
* <p/>
* <p>
* Duplicate values of properties should be silently removed by implementations,
* but clients must be able tolerate presence of duplicate values.
* <p/>
* <p>
* Operations that modify the objects work with the granularity of properties.
* They add/remove/replace the values of properties, but do not "see" inside the
* property.
* <p/>
* <p>
* This class represents schema definition for property. See {@link Definition}
* for more details.
*
Expand Down
Expand Up @@ -36,10 +36,10 @@

/**
* The triple of values (added, unchanged, deleted) that represents difference between two collections of values.
* <p/>
* <p>
* The DeltaSetTriple is used as a result of a "diff" operation or it is constructed to determine a ObjectDelta or
* PropertyDelta. It is a very useful structure in numerous situations when dealing with relative changes.
* <p/>
* <p>
* DeltaSetTriple (similarly to other parts of this system) deal only with unordered values.
*
* @author Radovan Semancik
Expand Down
Expand Up @@ -40,15 +40,15 @@

/**
* Relative difference (delta) of the object.
* <p/>
* <p>
* This class describes how the object changes. It can describe either object addition, modification of deletion.
* <p/>
* <p>
* Addition described complete new (absolute) state of the object.
* <p/>
* <p>
* Modification contains a set property deltas that describe relative changes to individual properties
* <p/>
* <p>
* Deletion does not contain anything. It only marks object for deletion.
* <p/>
* <p>
* The OID is mandatory for modification and deletion.
*
* @author Radovan Semancik
Expand Down
Expand Up @@ -39,7 +39,7 @@

/**
* Relative difference (delta) of a property values.
* <p/>
* <p>
* This class describes what values are to be added, removed or replaced in the property.
* The delta can be either add+delete or replace, but not both. It either describes what
* values to add and delete from the property (add+delete) or what is the new set of values
Expand All @@ -50,7 +50,7 @@
* @author Radovan Semancik
* @see ObjectDelta
*/
public class PropertyDelta<T extends Object> extends ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> {
public class PropertyDelta<T extends Object> extends ItemDelta<PrismPropertyValue<T>, PrismPropertyDefinition<T>> {

public PropertyDelta(PrismPropertyDefinition<T> propertyDefinition, PrismContext prismContext) {
super(propertyDefinition, prismContext);
Expand Down
Expand Up @@ -25,8 +25,10 @@ public MidpointYAMLGenerator(IOContext ctxt, int jsonFeatures, int yamlFeatures,

/**
* Brutal hack, as default behavior has lead to the following:
* {@code
* - !<http://midpoint.evolveum.com/xml/ns/public/model/scripting-3/SearchExpressionType>
* !<http://midpoint.evolveum.com/xml/ns/public/model/scripting-3/SearchExpressionType> '@element': "http://midpoint.evolveum.com/xml/ns/public/model/scripting-3#search"
* }
*
* (so we need to explicitly reset typeId after writing it)
*/
Expand Down

0 comments on commit 0ef8b5c

Please sign in to comment.