com.holonplatform.core.property

## Interface StringProperty

- All Superinterfaces:
    CloneableProperty<String,PathProperty<String>,PathProperty.Builder<String,PathProperty<String>,?>>, CloneableProperty.CloneablePathProperty<String,PathProperty<String>>, ConverterExpression<String>, DataMappable, Expression, HasConfiguration<PropertyConfiguration>, Localizable, Path<String>, PathExpression<String>, PathProperty<String>, Property<String>, QueryExpression<String>, QueryProjection<String>, Serializable, StringQueryExpression, TypedExpression<String>, Validator.Validatable<String>
  All Known Subinterfaces:
    StringBeanProperty, StringProperty.StringPropertyBuilder

      public interface StringProperty
      extends PathProperty<String>, StringQueryExpression

  A String type `PathProperty`.

  Extends `StringQueryExpression` to provide String type related query expression builder methods.

  Since:
    5.1.0

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `StringProperty.StringPropertyBuilder` `StringProperty` builder.

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.property.PathProperty

      `PathProperty.Builder<T,P extends Path<T> & Property<T>,B extends PathProperty.Builder<T,P,B>>, PathProperty.PathPropertyBuilder<T>`

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.property.CloneableProperty

      `CloneableProperty.CloneablePathProperty<T,P extends Property<T> & Path<T>>`

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.property.Property

      `Property.PropertyAccessException, Property.PropertyNotFoundException, Property.PropertyReadException, Property.PropertyReadOnlyException, Property.PropertyWriteException`

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.i18n.Localizable

      `Localizable.LocalizableBuilder, Localizable.LocalizationException`

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.Expression

      `Expression.ExpressionResolverFunction<E extends Expression,R extends Expression>, Expression.InvalidExpressionException`

    - ### Nested classes/interfaces inherited from interface com.holonplatform.core.Path

      `Path.FinalPath<T>, Path.PathBuilder<T>`

  - ### Field Summary

    - ### Fields inherited from interface com.holonplatform.core.Path

      `PATH_HIERARCHY_SEPARATOR`

    - ### Fields inherited from interface com.holonplatform.core.DataMappable

      `DEFAULT_CONFIG_PROPERTY_PREFIX, PATH`

  - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `clone(Consumer<PathProperty.Builder<String,PathProperty<String>,?>> builder)` Clone this property.
    `static StringProperty.StringPropertyBuilder` | `create(Path<String> path)` Create a new `StringProperty` from given `path`, using given `Path` `name`.
    `static StringProperty.StringPropertyBuilder` | `create(String name)` Create a new `StringProperty` with given `name`.

    - ### Methods inherited from interface com.holonplatform.core.property.PathProperty

      `create, create, isReadOnly`

    - ### Methods inherited from interface com.holonplatform.core.property.Property

      `getConfiguration, getConvertedValue, getConverter, getExpressionValueConverter, getName, getTemporalType, getType, present, render, renderIfAvailable`

    - ### Methods inherited from interface com.holonplatform.core.Validator.Validatable

      `getValidators, validate`

    - ### Methods inherited from interface com.holonplatform.core.i18n.Localizable

      `builder, getMessage, getMessageArguments, getMessageCode, of, of`

    - ### Methods inherited from interface com.holonplatform.core.HasConfiguration

      `hasConfiguration`

    - ### Methods inherited from interface com.holonplatform.core.ConverterExpression

      `getModelType, getModelValue`

    - ### Methods inherited from interface com.holonplatform.core.TypedExpression

      `isCollectionExpression, isConverterExpression`

    - ### Methods inherited from interface com.holonplatform.core.Expression

      `validate`

    - ### Methods inherited from interface com.holonplatform.core.query.PathExpression

      `asc, desc, from`

    - ### Methods inherited from interface com.holonplatform.core.Path

      `fullName, fullName, getName, getParent, isRootPath, of, relativeName, relativeName, stream`

    - ### Methods inherited from interface com.holonplatform.core.DataMappable

      `getDataPath, isDataMappable`

    - ### Methods inherited from interface com.holonplatform.core.query.QueryExpression

      `between, count, eq, eq, goe, goe, gt, gt, in, in, in, isNotNull, isNull, loe, loe, lt, lt, max, min, neq, neq, nin, nin, nin`

    - ### Methods inherited from interface com.holonplatform.core.query.QueryProjection

      `bean, constant, countAll, path, propertySet, propertySet`

    - ### Methods inherited from interface com.holonplatform.core.query.StringQueryExpression

      `contains, contains, containsIgnoreCase, endsWith, endsWith, endsWithIgnoreCase, lower, startsWith, startsWith, startsWithIgnoreCase, upper`

- - ### Method Detail

    - #### clone

          StringProperty clone(Consumer<PathProperty.Builder<String,PathProperty<String>,?>> builder)

      Clone this property.
      Specified by:
        `clone` in interface `CloneableProperty<String,PathProperty<String>,PathProperty.Builder<String,PathProperty<String>,?>>`
      Parameters:
        `builder` - A property builder which can be used to perform additional property configuration
      Returns:
        The cloned property

    - #### create

          static StringProperty.StringPropertyBuilder create(String name)

      Create a new `StringProperty` with given `name`.
      Parameters:
        `name` - Property name (not null)
      Returns:
        `StringProperty` builder

    - #### create

          static StringProperty.StringPropertyBuilder create(Path<String> path)

      Create a new `StringProperty` from given `path`, using given `Path` `name`.
      Parameters:
        `path` - Path from which to obtain the property path name (not null)
      Returns:
        `StringProperty` builder

Copyright © 2019 The Holon Platform. All rights reserved.