io.github.mmm.property.factory.PropertyFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmm-property Show documentation
Java module providing advanced powerful properties.
The newest version!
/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.property.factory;

import io.github.mmm.property.PropertyMetadata;
import io.github.mmm.property.ReadableProperty;
import io.github.mmm.property.WritableProperty;

/**
 * This is the interface for the factory of a specific {@link WritableProperty property} type. You can directly
 * instantiate implementations such as {@link io.github.mmm.property.string.StringProperty}. However for generic support
 * according types have to be registered via an implementation of this interface.
 *
 * @param  the generic type of the {@link WritableProperty#get() property value}.
 * @param  the generic type of the {@link #getImplementationClass() property implementation}.
 *
 * @see PropertyFactoryManager
 *
 * @since 1.0.0
 */
public interface PropertyFactory> {

  /**
   * @return the {@link Class} of the {@link ReadableProperty#get() property value}. May be {@code null} for a generic
   *         property.
   */
  Class getValueClass();

  /**
   * @return the {@link Class} reflecting the {@link ReadableProperty} interface. May be {@code null} if no dedicated
   *         readable interface exists.
   */
  Class> getReadableInterface();

  /**
   * @return the {@link Class} reflecting the {@link WritableProperty} interface. May be {@code null} if no dedicated
   *         writable interface exists.
   */
  Class> getWritableInterface();

  /**
   * @return the {@link Class} reflecting the {@link WritableProperty} implementation.
   */
  Class getImplementationClass();

  /**
   * Creates a new instance of the property.
   *
   * @param name the {@link ReadableProperty#getName() property name}.
   * @param valueClass the {@link ReadableProperty#getValueClass() value class}.
   * @param metadata the {@link ReadableProperty#getMetadata() metadata}.
   * @return the new instance of the property.
   */
  P create(String name, PropertyTypeInfo valueClass, PropertyMetadata metadata);

  /**
   * Creates a new instance of the property.
   *
   * @param name the {@link ReadableProperty#getName() property name}.
   * @param valueClass the {@link ReadableProperty#getValueClass() value class}.
   * @param metadata the {@link ReadableProperty#getMetadata() metadata}.
   * @return the new instance of the property.
   */
  default P create(String name, Class valueClass, PropertyMetadata metadata) {

    return create(name, PropertyTypeInfo.ofValueClass(valueClass), metadata);
  }

  /**
   * @return {@code true} if {@link #getValueClass() value class} is polymorphic and also sub-types are handled by this
   *         {@link PropertyFactory} (unless there is a more specific {@link PropertyFactory} available), {@code false}
   *         otherwise.
   */
  default boolean isPolymorphic() {

    return false;
  }

}