# Index

C D E G H I O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## C

ChildResource - Interface in org.apache.sling.validation.model
  Defines the validation rules for a child resource, allowing `ValidationModel`s to be applied to `Resource` trees.

## D

DefaultValidationFailure - Class in org.apache.sling.validation.spi.support
  Wraps a message key (being looked up in a `ResourceBundle`), messageArguments (being used with `MessageFormat.format(String, Object...)` and the location where the validation failure occurred.
DefaultValidationFailure(String, int, ResourceBundle, String, Object...) - Constructor for class org.apache.sling.validation.spi.support.DefaultValidationFailure
  Constructor of a validation failure.
DefaultValidationFailure(ValidatorContext, String, Object...) - Constructor for class org.apache.sling.validation.spi.support.DefaultValidationFailure
  Constructor of a validation failure.
DefaultValidationResult - Class in org.apache.sling.validation.spi.support
  Default implementation of `ValidationResult` wrapping a list of `ValidationFailure`s.
DefaultValidationResult(String, int, ResourceBundle, String, Object...) - Constructor for class org.apache.sling.validation.spi.support.DefaultValidationResult
  Constructs a result with one failure message.
DefaultValidationResult(ValidatorContext, String, Object...) - Constructor for class org.apache.sling.validation.spi.support.DefaultValidationResult
  Constructs a result with one failure message.
DefaultValidationResult(ValidationFailure...) - Constructor for class org.apache.sling.validation.spi.support.DefaultValidationResult

## E

equals(Object) - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure

## G

getApplicablePaths() - Method in interface org.apache.sling.validation.model.ValidationModel
  Returns the paths under which resources will be validated by this model.
getChildren() - Method in interface org.apache.sling.validation.model.ChildResource
  Returns the child resources of this part of the Validation Model
getChildren() - Method in interface org.apache.sling.validation.model.ValidationModel
  Returns the expected children for a resource validated by this model.
getDefaultResourceBundle() - Method in interface org.apache.sling.validation.spi.ValidatorContext
getFailures() - Method in class org.apache.sling.validation.spi.support.DefaultValidationResult
getFailures() - Method in interface org.apache.sling.validation.ValidationResult
  In case the validation failed (check the `ValidationResult.isValid()` method), this method returns the failure's causes.
getLocation() - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure
getLocation() - Method in interface org.apache.sling.validation.spi.ValidatorContext
getLocation() - Method in interface org.apache.sling.validation.ValidationFailure
  Returns the relative location of the property/resource/value which triggered this validation failure.
getMessage(ResourceBundle) - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure
getMessage(ResourceBundle) - Method in interface org.apache.sling.validation.ValidationFailure
getName() - Method in interface org.apache.sling.validation.model.ChildResource
  Return this resource's name.
getName() - Method in interface org.apache.sling.validation.model.ResourceProperty
  Returns the name of this property.
getNamePattern() - Method in interface org.apache.sling.validation.model.ChildResource
  Returns this resource's name pattern.
getNamePattern() - Method in interface org.apache.sling.validation.model.ResourceProperty
  Returns the name pattern for this property.
getParameters() - Method in interface org.apache.sling.validation.model.ValidatorInvocation
getProperties() - Method in interface org.apache.sling.validation.model.ChildResource
  Returns the properties this child resource is expected to have.
getResource() - Method in interface org.apache.sling.validation.spi.ValidatorContext
getResourceProperties() - Method in interface org.apache.sling.validation.model.ValidationModel
  Returns the properties validated by this model.
getSeverity() - Method in interface org.apache.sling.validation.model.ValidatorInvocation
getSeverity() - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure
getSeverity() - Method in interface org.apache.sling.validation.spi.ValidatorContext
  Returns the severity to be issued for validation failures in this context.
getSeverity() - Method in interface org.apache.sling.validation.ValidationFailure
getSource() - Method in interface org.apache.sling.validation.model.ValidationModel
getValidatingResourceType() - Method in interface org.apache.sling.validation.model.ValidationModel
  Returns the type of resource this model validates.
getValidationModel(String, String, boolean) - Method in interface org.apache.sling.validation.model.spi.ValidationModelRetriever
  A validation model for the given resourceType at the given resourcePath
getValidationModel(String, String, boolean) - Method in interface org.apache.sling.validation.ValidationService
  Tries to obtain a `ValidationModel` that is able to validate a `Resource` of type `validatedResourceType`.
getValidationModel(Resource, boolean) - Method in interface org.apache.sling.validation.ValidationService
  Tries to obtain a `ValidationModel` that is able to validate the given `resource`.
getValidationModels(String) - Method in interface org.apache.sling.validation.model.spi.ValidationModelProvider
  Retrieves the models responsible for validating the given resourceType.
getValidatorId() - Method in interface org.apache.sling.validation.model.ValidatorInvocation
getValidatorInvocations() - Method in interface org.apache.sling.validation.model.ResourceProperty
  Returns a list of `ValidatorInvocation`s which should be applied on this property.
getValueMap() - Method in interface org.apache.sling.validation.spi.ValidatorContext

## H

hashCode() - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure

## I

isMultiple() - Method in interface org.apache.sling.validation.model.ResourceProperty
isRequired() - Method in interface org.apache.sling.validation.model.ChildResource
  Returns `true` if at least one resource matching the name/namePattern is required.
isRequired() - Method in interface org.apache.sling.validation.model.ResourceProperty
  Returns `true` if at least one property matching the name/namePattern is required.
isValid() - Method in class org.apache.sling.validation.spi.support.DefaultValidationResult
isValid() - Method in interface org.apache.sling.validation.ValidationResult
  Tells if the validation was successful or not.

## O

org.apache.sling.validation - package org.apache.sling.validation
org.apache.sling.validation.model - package org.apache.sling.validation.model
org.apache.sling.validation.model.spi - package org.apache.sling.validation.model.spi
org.apache.sling.validation.spi - package org.apache.sling.validation.spi
org.apache.sling.validation.spi.support - package org.apache.sling.validation.spi.support

## P

PROPERTY_VALIDATOR_ID - Static variable in interface org.apache.sling.validation.spi.Validator
  Each `Validator` must have a service property with name `validator.id` of type `String`.
PROPERTY_VALIDATOR_SEVERITY - Static variable in interface org.apache.sling.validation.spi.Validator
  Each `Validator` may have a service property with name `validator.severity` of type `Integer`.

## R

ResourceProperty - Interface in org.apache.sling.validation.model
  Describes a `Resource` property.

## S

SlingValidationException - Exception in org.apache.sling.validation
  Exception that is thrown for Validator inconsistencies, e.g. if a mandatory parameter for a validator is missing.
SlingValidationException(String) - Constructor for exception org.apache.sling.validation.SlingValidationException
SlingValidationException(String, Throwable) - Constructor for exception org.apache.sling.validation.SlingValidationException

## T

toString() - Method in class org.apache.sling.validation.spi.support.DefaultValidationFailure

## V

VALID - Static variable in class org.apache.sling.validation.spi.support.DefaultValidationResult
  Used to indicated a valid result.
validate(Resource, ValidationModel) - Method in interface org.apache.sling.validation.ValidationService
  Validates a `Resource` using a specific `ValidationModel`.
validate(ValueMap, ValidationModel) - Method in interface org.apache.sling.validation.ValidationService
  Validates a `ValueMap` or any object adaptable to a `ValueMap` using a specific `ValidationModel`.
validate(T, ValidatorContext, ValueMap) - Method in interface org.apache.sling.validation.spi.Validator
  Validates the `data` and/or the `valueMap` according to the internal constraints of this validator.
validateResourceRecursively(Resource, boolean, Predicate<Resource>, boolean) - Method in interface org.apache.sling.validation.ValidationService
  Validates a `Resource` and all child resources recursively by traversing through the resource tree starting from the given resource.
ValidationFailure - Interface in org.apache.sling.validation
ValidationModel - Interface in org.apache.sling.validation.model
  A `ValidationModel` defines the validation rules that a resource tree has to pass.
ValidationModelProvider - Interface in org.apache.sling.validation.model.spi
  All providers of `ValidationModel`s must implement this interface.
ValidationModelRetriever - Interface in org.apache.sling.validation.model.spi
  Retrieves the validation model.
ValidationResult - Interface in org.apache.sling.validation
  A `ValidationResult` contains validation information either from a single `Validator` or from multiple Validator invocations.
ValidationService - Interface in org.apache.sling.validation
  The `ValidationService` provides methods for finding `ValidationModel`s and to trigger validations against those.
Validator<T> - Interface in org.apache.sling.validation.spi
  A `Validator` is responsible for validating a single piece of information according to an internal constraint.
ValidatorContext - Interface in org.apache.sling.validation.spi
  Used as parameter for each call of `Validator.validate(Object, ValidatorContext, ValueMap)` Exposes additional information about the context in which the validation was called.
ValidatorInvocation - Interface in org.apache.sling.validation.model
  Defines a specific validator invocation for a given property (without actually exposing a reference to the underlying `Validator`).

C D E G H I O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form