org.apache.tamaya.model.spi

## Class ConfigModelGroup

- java.lang.Object
- - org.apache.tamaya.model.spi.ConfigModelGroup

- All Implemented Interfaces:
    ConfigModel
  Direct Known Subclasses:
    AreaConfigModel

      public class ConfigModelGroup
      extends Object
      implements ConfigModel

  Default configuration Model for a configuration area.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ConfigModelGroup(String name, String provider, Collection<ConfigModel> configModels)`
    `ConfigModelGroup(String name, String provider, ConfigModel... configModels)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getDescription()` Get an description of the item, using the default locale.
    `String` | `getName()` Get the item's name, it should minimally describe the validation.
    `String` | `getProvider()` Get the provider of this validation.
    `ModelType` | `getType()` Get the type of item that is modelled.
    `Collection<ConfigModel>` | `getValidations()`
    `boolean` | `isRequired()` Check if this validation is a required one.
    `String` | `toString()`
    `Collection<ValidationResult>` | `validate(org.apache.tamaya.Configuration config)` Validates the item and all its children against the given configuration.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ConfigModelGroup

          public ConfigModelGroup(String name,
                          String provider,
                          ConfigModel... configModels)

    - #### ConfigModelGroup

          public ConfigModelGroup(String name,
                          String provider,
                          Collection<ConfigModel> configModels)

  - ### Method Detail

    - #### getName

          public String getName()

      Description copied from interface: `ConfigModel`
      Get the item's name, it should minimally describe the validation. Examples are:

               Sections: a.b.c
               Params: a.b.c.paramName
               Filter: a.b.c.FilterImplClass
               Dependency: mydepClassname
               CombinationPolicy: a.b.c.MyCombinationPolicyClass

      Specified by:
        `getName` in interface `ConfigModel`
      Returns:
        the item's name.

    - #### getProvider

          public String getProvider()

      Description copied from interface: `ConfigModel`
      Get the provider of this validation.
      Specified by:
        `getProvider` in interface `ConfigModel`
      Returns:
        the provider.

    - #### isRequired

          public boolean isRequired()

      Description copied from interface: `ConfigModel`
      Check if this validation is a required one.
      Specified by:
        `isRequired` in interface `ConfigModel`
      Returns:
        true, if this validation is required.

    - #### getType

          public ModelType getType()

      Description copied from interface: `ConfigModel`
      Get the type of item that is modelled.
      Specified by:
        `getType` in interface `ConfigModel`
      Returns:
        the modelled type, never null.

    - #### getDescription

          public String getDescription()

      Description copied from interface: `ConfigModel`
      Get an description of the item, using the default locale. The description is basically optional though it is higly recommended to provide a description, so the validation issues is well resolvable.
      Specified by:
        `getDescription` in interface `ConfigModel`
      Returns:
        the description required, or null.

    - #### getValidations

          public Collection<ConfigModel> getValidations()

    - #### validate

          public Collection<ValidationResult> validate(org.apache.tamaya.Configuration config)

      Description copied from interface: `ConfigModel`
      Validates the item and all its children against the given configuration.
      Specified by:
        `validate` in interface `ConfigModel`
      Parameters:
        `config` - the configuration to be validated against, not null.
      Returns:
        the validation results, never null.

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2014–2016 Apache Software Foundation. All rights reserved.