Author: kwin
Date: Thu Mar 16 14:37:09 2017
New Revision: 1787191
URL: http://svn.apache.org/viewvc?rev=1787191&view=rev
Log:
fix javadoc
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationFailure.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationResult.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationService.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/model/spi/ValidationModelProvider.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationFailure.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/ValidationContext.java
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/Validator.java
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationFailure.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationFailure.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationFailure.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationFailure.java
Thu Mar 16 14:37:09 2017
@@ -37,7 +37,7 @@ public interface ValidationFailure {
* Returns the relative location of the property/resource/value which
triggered this validation failure.
* The location
* <ul>
- * <li>is relative to the resource given in the first parameter in case it
was returned by {@link
ValidationService#validate(org.apache.sling.api.resource.Resource,
org.apache.sling.validation.model.ValidationModel)} or {@link
ValidationService#validateResourceRecursively(org.apache.sling.api.resource.Resource,
boolean, org.apache.commons.collections.Predicate, boolean)} or</li>
+ * <li>is relative to the resource given in the first parameter in case it
was returned by {@link
ValidationService#validate(org.apache.sling.api.resource.Resource,
org.apache.sling.validation.model.ValidationModel)} or {@link
ValidationService#validateResourceRecursively(org.apache.sling.api.resource.Resource,
boolean, java.util.function.Predicate, boolean)} or</li>
* <li>contains just the value name in case it was returned by {@link
ValidationService#validate(org.apache.sling.api.resource.ValueMap,
org.apache.sling.validation.model.ValidationModel)}</li>
* </ul>
* @return the location (usually the validated resource's property path).
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationResult.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationResult.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationResult.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationResult.java
Thu Mar 16 14:37:09 2017
@@ -26,7 +26,7 @@ import org.osgi.annotation.versioning.Pr
/**
- * A {@code ValidationResult} contains validation information either from a
single {@link Validator} or from multiple Validator invocations.
+ * A {@code ValidationResult} contains validation information either from a
single {@link org.apache.sling.validation.spi.Validator} or from multiple
Validator invocations.
*/
@ProviderType
public interface ValidationResult {
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationService.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationService.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationService.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/ValidationService.java
Thu Mar 16 14:37:09 2017
@@ -24,6 +24,7 @@ import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.validation.model.ValidationModel;
import org.osgi.annotation.versioning.ProviderType;
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/model/spi/ValidationModelProvider.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/model/spi/ValidationModelProvider.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/model/spi/ValidationModelProvider.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/model/spi/ValidationModelProvider.java
Thu Mar 16 14:37:09 2017
@@ -23,6 +23,7 @@ import java.util.Map;
import javax.annotation.Nonnull;
+import org.apache.sling.validation.ValidationService;
import org.apache.sling.validation.model.ValidationModel;
import org.apache.sling.validation.model.ValidatorAndSeverity;
import org.osgi.annotation.versioning.ProviderType;
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationFailure.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationFailure.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationFailure.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationFailure.java
Thu Mar 16 14:37:09 2017
@@ -61,9 +61,9 @@ public final class DefaultValidationFail
/**
* Constructor of a validation failure.
- * @param location the location where the validation error occured
- * @param severity the severity of this failure (may be {@code null}),
which leads to setting it to the {@link #DEFAULT_SEVERITY}
- * @param defaultResourceBundle the default resourceBundle which is used
to resolve the {@link messageKey} in {@link #getMessage(ResourceBundle)}
+ * @param location the location where the validation error occurred
+ * @param severity the severity of this failure (may be {@code null} which
leads to using the validator's default severity)
+ * @param defaultResourceBundle the default resourceBundle which is used
to resolve the {@code messageKey} in {@link #getMessage(ResourceBundle)}
* if {@code null} is provided as parameter.
* @param messageKey the key to look up in the resource bundle
* @param messageArguments the arguments to be used with the looked up
value from the resource bundle (given in {@link #getMessage(ResourceBundle)}
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java
Thu Mar 16 14:37:09 2017
@@ -19,6 +19,7 @@
package org.apache.sling.validation.spi;
import java.io.Serializable;
+import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@@ -53,7 +54,7 @@ public final class DefaultValidationResu
* Constructs a result with one failure message. The message is
constructed by looking up the given messageKey from a resourceBundle.
* and formatting it using the given messageArguments via {@link
MessageFormat#format(String, Object...)}.
* @param validationContext the context from which to take the location,
severity and default resource bundle
- * @param messageKey the message key used for looking up a value in the
resource bundle given in {@link
ValidationFailure#getMessage(java.util.ResourceBundle)}.
+ * @param messageKey the message key used for looking up a value in the
resource bundle given in {@link
ValidationFailure#getMessage(java.util.ResourceBundle)}
* @param messageArguments optional number of arguments being used in
{@link MessageFormat#format(String, Object...)}
*/
public DefaultValidationResult(@Nonnull ValidationContext
validationContext, @Nonnull String messageKey, Object... messageArguments) {
@@ -64,10 +65,10 @@ public final class DefaultValidationResu
/**
* Constructs a result with one failure message. The message is
constructed by looking up the given messageKey from a resourceBundle.
* and formatting it using the given messageArguments via {@link
MessageFormat#format(String, Object...)}.
- * @param location the location.
- * @param severity the severity of the embedded failure (may be {@code
null}), which leads to setting it to the {@link #DEFAULT_SEVERITY}.
- * @param defaultResourceBundle the default resourceBundle which is used
to resolve the {@link messageKey} if no other bundle is provided.
- * @param messageKey the message key used for looking up a value in the
resource bundle given in {@link
ValidationFailure#getMessage(java.util.ResourceBundle)}.
+ * @param location the location
+ * @param severity the severity of the embedded failure (may be {@code
null} which leads to using the validator's default severity)
+ * @param defaultResourceBundle the default resourceBundle which is used
to resolve the {@code messageKey} if no other bundle is provided
+ * @param messageKey the message key used for looking up a value in the
resource bundle given in {@link
ValidationFailure#getMessage(java.util.ResourceBundle)}
* @param messageArguments optional number of arguments being used in
{@link MessageFormat#format(String, Object...)}
*/
public DefaultValidationResult(@Nonnull String location, int severity,
@Nonnull ResourceBundle defaultResourceBundle, @Nonnull String messageKey,
Object... messageArguments) {
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/ValidationContext.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/ValidationContext.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/ValidationContext.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/ValidationContext.java
Thu Mar 16 14:37:09 2017
@@ -25,6 +25,7 @@ import javax.annotation.Nonnull;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.validation.ValidationService;
import org.osgi.annotation.versioning.ProviderType;
@@ -57,8 +58,7 @@ public interface ValidationContext {
int getSeverity();
/**
- * The default resource bundle which should be able to give out the error
message of the validator in English.
- * @return
+ * @return resource bundle which should be able to give out the error
message of the {@link Validator} in English.
*/
@Nonnull ResourceBundle getDefaultResourceBundle();
}
Modified:
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/Validator.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/Validator.java?rev=1787191&r1=1787190&r2=1787191&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/Validator.java
(original)
+++
sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/Validator.java
Thu Mar 16 14:37:09 2017
@@ -22,6 +22,7 @@ import javax.annotation.Nonnull;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.validation.SlingValidationException;
+import org.apache.sling.validation.ValidationFailure;
import org.apache.sling.validation.ValidationResult;
import org.osgi.annotation.versioning.ConsumerType;
