[hibernate-commits] Hibernate SVN: r15513 - in validator/trunk/validation-api/src/main/java/javax/validation: bootstrap and 2 other directories.

Author: epbernard Date: 2008-11-05 00:55:13 -0500 (Wed, 05 Nov 2008) New Revision: 15513 Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintContext.java validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java validator/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java validator/trunk/validation-api/src/main/java/javax/validation/MessageResolver.java validator/trunk/validation-api/src/main/java/javax/validation/Validation.java validator/trunk/validation-api/src/main/java/javax/validation/ValidationProviderResolver.java validator/trunk/validation-api/src/main/java/javax/validation/Validator.java validator/trunk/validation-api/src/main/java/javax/validation/ValidatorFactoryBuilder.java validator/trunk/validation-api/src/main/java/javax/validation/bootstrap/SpecializedBuilderFactory.java validator/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java validator/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java validator/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java validator/trunk/validation-api/src/main/java/javax/validation/spi/BootstrapState.java validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidatorFactoryConfiguration.java Log: Javadoc style Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintContext.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/ConstraintContext.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/ConstraintContext.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -31,7 +31,8 @@ * Aside from the error message, ConstraintViolation objects generated from such a call * contains the same contextual information (root bean, path and so on) * <p/> - * This method can be called multiple time. One ConstraintViolation instance per call is created. + * This method can be called multiple time. One ConstraintViolation instance per + * call is created. * * @param message new unexpanded error message */ @@ -40,8 +41,10 @@ /** * Add a new unexpanded error message to a given sub property. * <p/> - * If isValid returns false, a ConstraintViolation object will be built per error message including the default one - * if null apply to the current property or the bean the constraint is applied on, otherwise apply to the <code>property</code> named + * If isValid returns false, a ConstraintViolation object will be built + * per error message including the default one + * if null apply to the current property or the bean the constraint is applied on, + * otherwise apply to the <code>property</code> named * <p/> * TODO exception or swallowed when bean level instance is not present? * Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -48,10 +48,10 @@ Class<? extends Constraint> getConstraintClass(); /** - * Returns a map containing the annotation parameter names as keys and the annotation parameter values - * as value. - * If this constraint is used as part of a composed constraint, parameter values are reflecting - * the overridden parameters form the main constraint. + * Returns a map containing the annotation parameter names as keys and the + * annotation parameter values as value. + * If this constraint is used as part of a composed constraint, parameter + * values are reflecting the overridden parameters form the main constraint. * * @return Returns a map containing the annotation paramter names as keys and the annotation parameter values * as value. Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -40,9 +40,11 @@ /** * If a bean constraint, the bean instance the constraint is applied on - * If a property constraint, the bean instance hosting the property the constraint is applied on + * If a property constraint, the bean instance hosting the property the + * constraint is applied on * - * @return the leaf bean the constraint is applied on or null if Validator#validateValue is used + * @return the leaf bean the constraint is applied on or null if Validator#validateValue + * is used */ Object getLeafBean(); @@ -54,7 +56,7 @@ /** - * @return the bean type being validated. + * @return the type of interface or class being validated. */ Class<T> getBeanClass(); Modified: validator/trunk/validation-api/src/main/java/javax/validation/MessageResolver.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/MessageResolver.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/MessageResolver.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -37,7 +37,9 @@ * * @return Interpolated error message. */ - String interpolate(String message, ConstraintDescriptor constraintDescriptor, Object value); + String interpolate(String message, + ConstraintDescriptor constraintDescriptor, + Object value); /** * Interpolate the message from the constraint parameters and the actual validated object. @@ -50,5 +52,8 @@ * * @return Interpolated error message. */ - String interpolate(String message, ConstraintDescriptor constraintDescriptor, Object value, Locale locale); + String interpolate(String message, + ConstraintDescriptor constraintDescriptor, + Object value, + Locale locale); } Modified: validator/trunk/validation-api/src/main/java/javax/validation/Validation.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/Validation.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/Validation.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -24,26 +24,30 @@ import javax.validation.spi.ValidationProvider; /** - * This class is the entry point for the Bean Validation framework. There are three ways to bootstrap the framework: + * This class is the entry point for the Bean Validation framework. There are three ways + * to bootstrap the framework: * <ul> * <li> * The easiest approach is to use the default Bean Validation provider. * <pre> * ValidatorFactory factory = Validation.getBuilder().build(); * </pre> - * In this case {@link javax.validation.bootstrap.DefaultValidationProviderResolver DefaultValidationProviderResolver} + * In this case {@link javax.validation.bootstrap.DefaultValidationProviderResolver} * will be used to locate available providers. * * The chosen provider is defined as followed: * <ul> * <li>if the XML configuration defines a provider, this provider is used</li> - * <li>if the XML configuratio does not define a provider or if no XML configuration is present the first provider - * returned by the ValidationProviderResolver isntance is used.</li> + * <li>if the XML configuratio does not define a provider or if no XML configuration + * is present the first provider returned by the ValidationProviderResolver + * isntance is used.</li> * </ul> * </li> * <li> - * The second bootstrap approach allows to choose a custom <code>ValidationProviderResolver</code>. The chosen - * <code>ValidationProvider</code> is then determined in the same way as in the default bootstrapping case (see above). + * The second bootstrap approach allows to choose a custom + * <code>ValidationProviderResolver</code>. The chosen + * <code>ValidationProvider</code> is then determined in the same way + * as in the default bootstrapping case (see above). * <pre> * ValidatorFactoryBuilder&lt?&gt; builder = Validation * .defineBootstrapState() @@ -55,7 +59,8 @@ * * <p/> * <li> - * The third approach allows you to specify explicitly and in a type safe fashion the expected provider by + * The third approach allows you to specify explicitly and in + * a type safe fashion the expected provider by * using its specific <code>ValidatorFactoryBuilder</code> sub-interface. * * Optionally you can choose a custom <code>ValidationProviderResolver</code>. @@ -71,8 +76,8 @@ * Note:<br/> * <ul> * <li> - * The ValidatorFactory object built by the bootstrap process should be cached and shared amongst - * Validator consumers. + * The ValidatorFactory object built by the bootstrap process should be cached + * and shared amongst Validator consumers. * </li> * <li> * This class is thread-safe. @@ -86,10 +91,12 @@ public class Validation { /** - * Build a <code>ValidatorFactoryBuilder</code>. The actual provider choice is given by the XML configuration. If the + * Build a <code>ValidatorFactoryBuilder</code>. The actual provider + * choice is given by the XML configuration. If the * XML configuration does not exsist the default is taken. * <p/> - * The provider list is resolved using the {@link javax.validation.bootstrap.DefaultValidationProviderResolver DefaultValidationProviderResolver}. + * The provider list is resolved using the + * {@link javax.validation.bootstrap.DefaultValidationProviderResolver}. * * @return <code>ValidatorFactoryBuilder</code> instance. */ @@ -98,7 +105,8 @@ } /** - * Build a <code>ValidatorFactoryBuilder</code>. The provider list is resolved using the strategy provided to the bootstrap state. + * Build a <code>ValidatorFactoryBuilder</code>. The provider list is resolved + * using the strategy provided to the bootstrap state. * <pre> * ValidatorFactoryBuilder&lt?&gt; builder = Validation * .defineBootstrapState() @@ -106,10 +114,11 @@ * .getBuilder(); * ValidatorFactory factory = builder.build(); * </pre> - * The actual provider choice is given by the XML configuration. If the XML configuration does not exsist the first - * available provider will be returned. + * The actual provider choice is given by the XML configuration. If the XML + * configuration does not exsist the first available provider will be returned. * - * @return instance building a generic <code>ValidatorFactoryBuilder</code> compliant with the bootstrap state provided. + * @return instance building a generic <code>ValidatorFactoryBuilder</code> + * compliant with the bootstrap state provided. */ public static GenericBuilderFactory defineBootstrapState() { return new GenericBuilderFactoryImpl(); @@ -126,16 +135,19 @@ * .providerResolver( new MyResolverStrategy() ) * .build(); * </pre>, - * where <code>ACMEValidatorFactoryBuilder</code> is the <code>ValidatorFactoryBuilder</code> sub interface uniquely identifying - * the ACME Bean Validation provider. + * where <code>ACMEValidatorFactoryBuilder</code> is the <code>ValidatorFactoryBuilder</code> + * sub interface uniquely identifying the ACME Bean Validation provider. * - * @param builderType the <code>ValidatorFactoryBuilder</code> sub interface uniquely defining the targeted provider. + * @param builderType the <code>ValidatorFactoryBuilder</code> sub interface + * uniquely defining the targeted provider. * - * @return instance building a provider specific <code>ValidatorFactoryBuilder</code> sub interface implementation. + * @return instance building a provider specific <code>ValidatorFactoryBuilder</code> + * sub interface implementation. * * @see #getBuilder() */ - public static <T extends ValidatorFactoryBuilder<T>> SpecializedBuilderFactory<T> builderType(Class<T> builderType) { + public static <T extends ValidatorFactoryBuilder<T>> + SpecializedBuilderFactory<T> builderType(Class<T> builderType) { return new SpecializedBuilderFactoryImpl<T>( builderType ); } Modified: validator/trunk/validation-api/src/main/java/javax/validation/ValidationProviderResolver.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/ValidationProviderResolver.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/ValidationProviderResolver.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -23,7 +23,8 @@ /** * Determine the list of Bean Validation providers available in the runtime environment * <p/> - * Bean Validation providers are identified by the presence of META-INF/services/javax.validation.spi.ValidationProvider + * Bean Validation providers are identified by the presence of + * META-INF/services/javax.validation.spi.ValidationProvider * files following the Service Provider pattern described * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#Service... * <p/> Modified: validator/trunk/validation-api/src/main/java/javax/validation/Validator.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -32,7 +32,8 @@ * validate all constraints on object * * @param object object to validate - * @param groups group name(s) (including group sequence names) targeted for validation (default to &lt;code&gt;default&lt;/code&gt;) + * @param groups group name(s) (including group sequence names) targeted + * for validation (default to &lt;code&gt;default&lt;/code&gt;) * * @return constraint violations or an empty Set if none * @@ -45,7 +46,8 @@ * * @param object object to validate * @param propertyName property to validate (ie field and getter constraints) - * @param groups group name(s) (including group sequence names) targeted for validation (default to &lt;code&gt;default&lt;/code&gt;) + * @param groups group name(s) (including group sequence names) targeted + * for validation (default to &lt;code&gt;default&lt;/code&gt;) * * @return constraint violations or an empty Set if none * @@ -61,7 +63,8 @@ * * @param propertyName property to validate * @param value property value to validate - * @param groups group name(s) (including group sequence names) targeted for validation (default to <code>default</code>) + * @param groups group name(s) (including group sequence names) targeted + * for validation (default to <code>default</code>) * * @return constraint violations or an empty Set if none */ Modified: validator/trunk/validation-api/src/main/java/javax/validation/ValidatorFactoryBuilder.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/ValidatorFactoryBuilder.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/ValidatorFactoryBuilder.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -32,12 +32,13 @@ * .build(); * </pre> * <p/> - * The ValidationProviderResolver is specified at ValidatorFactoryBuilder time (see {@link javax.validation.spi.ValidationProvider}). + * The ValidationProviderResolver is specified at ValidatorFactoryBuilder time + * (see {@link javax.validation.spi.ValidationProvider}). * If none is explicitely requested, the default ValidationProviderResolver is used. * <p/> * The provider is selected in the following way: - * - if a specific ValidatorFactoryBuilder subclass is requested programmatically using Validation.builderType(), - * find the first provider matching it + * - if a specific ValidatorFactoryBuilder subclass is requested programmatically using + * Validation.builderType(), find the first provider matching it * - if a specific ValidatorFactoryBuilder subclass is defined in META-INF/validation.xml, * find the first provider matching it * - otherwise, use the first provider returned by the ValidationProviderResolver @@ -48,7 +49,8 @@ */ public interface ValidatorFactoryBuilder<T extends ValidatorFactoryBuilder> { /** - * Defines the message resolver used. Has priority over the configuration based message resolver. + * Defines the message resolver used. Has priority over the configuration + * based message resolver. * * @param resolver message resolver implementation. * @@ -57,7 +59,8 @@ T messageResolver(MessageResolver resolver); /** - * Defines the constraint factory. Has priority over the configuration based constraint factory. + * Defines the constraint factory. Has priority over the configuration + * based constraint factory. * * @param constraintFactory constraint factory inmplementation. * @@ -69,7 +72,8 @@ * Configure the ValidatorFactory based on <code>stream</code> * If not specified, META-INF/validation.xml is used * <p/> - * The stream should be closed by the client API after the ValidatorFactory has been returned + * The stream should be closed by the client API after the + * ValidatorFactory has been returned * * @param stream configuration stream. * Modified: validator/trunk/validation-api/src/main/java/javax/validation/bootstrap/SpecializedBuilderFactory.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/bootstrap/SpecializedBuilderFactory.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/bootstrap/SpecializedBuilderFactory.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -4,12 +4,13 @@ import javax.validation.ValidatorFactoryBuilder; /** - * Build implementations of builderType, the specific ValidatorFactoryBuilder sub interface uniquely identifying - * a provider. + * Build implementations of builderType, the specific ValidatorFactoryBuilder + * sub interface uniquely identifying a provider. * <p/> * The requested provider is the first provider suitable for T (as defined in - * {@link javax.validation.spi.ValidationProvider#isSuitable(Class)}). The list of providers evaluated is - * returned by {@link ValidationProviderResolver}. If no ValidationProviderResolver is defined, the + * {@link javax.validation.spi.ValidationProvider#isSuitable(Class)}). The + * list of providers evaluated is returned by {@link ValidationProviderResolver}. + * If no ValidationProviderResolver is defined, the * default ValidationProviderResolver strategy is used. * * @author Emmanuel Bernard @@ -27,8 +28,8 @@ public SpecializedBuilderFactory<T> providerResolver(ValidationProviderResolver resolver); /** - * Determine the provider implementation suitable for builderType and delegate the creation - * of this specific ValidatorFactoryBuilder subclass to the provider. + * Determine the provider implementation suitable for builderType and delegate + * the creation of this specific ValidatorFactoryBuilder subclass to the provider. * * @return a ValidatorFactoryBuilder sub interface implementation */ Modified: validator/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -33,7 +33,8 @@ * <li><code>BigInteger</code></li> * <li><code>Number</code></li> * <li><code>String</code></li> - * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, <code>double</code></li> + * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, + * <code>double</code></li> * </ul> * <p/> * <code>null</code> elements are considered valid Modified: validator/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -35,7 +35,8 @@ * <li><code>BigInteger</code></li> * <li><code>Number</code></li> * <li><code>String</code></li> - * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, <code>double</code></li> + * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, + * <code>double</code></li> * </ul> * <p/> * <code>null</code> elements are considered valid Modified: validator/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -35,7 +35,8 @@ * <li><code>BigInteger</code></li> * <li><code>Number</code></li> * <li><code>String</code></li> - * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, <code>double</code></li> + * <li><code>short</code>, <code>int</code>, <code>long</code>, <code>float</code>, + * <code>double</code></li> * </ul> * <p/> * <code>null</code> elements are considered valid Modified: validator/trunk/validation-api/src/main/java/javax/validation/spi/BootstrapState.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/spi/BootstrapState.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/spi/BootstrapState.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -9,7 +9,8 @@ */ public interface BootstrapState { /** - * returns the user defined ValidationProviderResolver strategy instance or <code>null</code> if undefined. + * returns the user defined ValidationProviderResolver strategy instance or <code>null</code> + * if undefined. * * @return ValidationProviderResolver instance or null */ Modified: validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -23,34 +23,40 @@ /** * Contract between the validation bootstrap mechanism and the provider engine. * <p/> - * Implementations must have a public no-arg constructor. The construction of a provider should be - * as "lightweight" as possible. + * Implementations must have a public no-arg constructor. The construction of a provider + * should be as "lightweight" as possible. * * @author Emmanuel Bernard * @author Hardy Ferentschik */ public interface ValidationProvider { /** + * This sub interface uniquely identify a provider. + * * @param builderClass targeted builder class. * - * @return <code>true</code> if <code>builderClass</code> is the Bean Validation Provider sub interface for ValidatorFactoryBuilder - * This sub interface uniquely identify a provider. + * @return <code>true</code> if <code>builderClass</code> is the Bean Validation Provider sub + * interface for ValidatorFactoryBuilder */ boolean isSuitable(Class<? extends ValidatorFactoryBuilder<?>> builderClass); /** - * Returns a ValidatorFactoryBuilder instance implementing the <code>builderType</code> interface. - * The ValidatorFactoryBuilder instance uses the current provider (<code>this</code>) to build - * the ValidatorFactory instance. + * Returns a ValidatorFactoryBuilder instance implementing the + * <code>builderType</code> interface. + * The ValidatorFactoryBuilder instance uses the current provider (<code>this</code>) + * to build the ValidatorFactory instance. * <p/> - * This method can only be called on providers returning true on <code>#issuitable(builderType)</code> + * This method can only be called on providers returning true on < + * code>#issuitable(builderType)</code> * * @param builderClass the Builder class type * @param state bootstrap state * * @return specific validator builder implementation */ - <T extends ValidatorFactoryBuilder<T>> T createSpecializedValidatorFactoryBuilder(BootstrapState state, Class<T> builderClass); + <T extends ValidatorFactoryBuilder<T>> T createSpecializedValidatorFactoryBuilder( + BootstrapState state, + Class<T> builderClass); /** * Returns a ValidatorFactoryBuilder instance. This instance is not bound to @@ -67,8 +73,9 @@ ValidatorFactoryBuilder<?> createGenericValidatorFactoryBuilder(BootstrapState state); /** - * Build a ValidatorFactory using the current provider implementation. The ValidatorFactory - * is assembled and follow the configuration passed using ValidatorFactoryConfiguration. + * Build a ValidatorFactory using the current provider implementation. The + * ValidatorFactory is assembled and follow the configuration passed + * using ValidatorFactoryConfiguration. * <p> * The returned ValidatorFactory is properly initialized and ready for use. * </p> Modified: validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidatorFactoryConfiguration.java =================================================================== --- validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidatorFactoryConfiguration.java 2008-11-05 01:51:02 UTC (rev 15512) +++ validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidatorFactoryConfiguration.java 2008-11-05 05:55:13 UTC (rev 15513) @@ -22,9 +22,10 @@ import javax.validation.MessageResolver; /** - * Contract between a <code>ValidatorFactoryBuilder</code> and a </code>ValidatorProvider</code> to create - * a <code>ValidatorFactory</code>. - * The configuration artifacts provided to the <code>ValidatorFactoryBuilder</code> are passed along. + * Contract between a <code>ValidatorFactoryBuilder</code> and a + * </code>ValidatorProvider</code> to create a <code>ValidatorFactory</code>. + * The configuration artifacts provided to the + * <code>ValidatorFactoryBuilder</code> are passed along. * * @author Emmanuel Bernard * @author Hardy Ferentschik @@ -47,8 +48,8 @@ InputStream getConfigurationStream(); /** - * Defines the constraint implementation factory as defined by the client programmatically - * or null if undefined + * Defines the constraint implementation factory as defined by + * the client programmatically or null if undefined * * @return factory instance or null if not defined */