eu.mihosoft.vmf.vmftext.grammar.Property Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vmf-text Show documentation
VMF-Text
The newest version!

package eu.mihosoft.vmf.vmftext.grammar;

// vmf imports
//import eu.mihosoft.vmf.runtime.core.*;
import eu.mihosoft.vcollections.*;

// property types imports

// interface

/**
 * A representation of the model object {@code eu.mihosoft.vmf.vmftext.grammar.Property}.
 *
 * 
 * 
 *
 */
public interface Property extends eu.mihosoft.vmf.runtime.core.VObject, WithName,WithType,CodeElement, Cloneable, eu.mihosoft.vmf.runtime.core.Mutable {


  /**
   * Returns the value of the 'annotations' containment list.
   *
   * It is bidirectional and its opposite is '{@link PropertyAnnotation#getProperty() property}'.
   *
   * 
   * 
   *
   * @return the value of the 'annotations' containment list.
   */
  eu.mihosoft.vcollections.VList getAnnotations();




/**
 * Returns the value of the 'parent' container reference.
 *
 * It is bidirectional and its opposite is '{@link eu.mihosoft.vmf.vmftext.grammar.RuleClass#getProperties() properties}'.
 *
 * 
 * 
 *
 * @return the value of the 'parent' container reference.
 * @see Property#setParent(eu.mihosoft.vmf.vmftext.grammar.RuleClass)
 */
 eu.mihosoft.vmf.vmftext.grammar.RuleClass getParent();

 /**
  * Sets the value of the 'parent' property.
  *
  * 
  * 
  *
  * @param parent the value to set
  * @see Property#getParent()
  */
  void setParent(eu.mihosoft.vmf.vmftext.grammar.RuleClass parent);



   /**
   * Returns the value of the 'type' property.
   *
   * 
   * 
   *
   * @return the value of the 'type' property.
   * @see Property#setType(eu.mihosoft.vmf.vmftext.grammar.Type)
   */
 eu.mihosoft.vmf.vmftext.grammar.Type getType();

 /**
  * Sets the value of the 'type' property.
  *
  * 
  * 
  *
  * @param type the value to set
  * @see Property#getType()
  */
  void setType(eu.mihosoft.vmf.vmftext.grammar.Type type);



// --------------------------------------------------------------------
// --- declaration of delegation methods
// --------------------------------------------------------------------

  public java.lang.String nameWithLower();
  public java.lang.String nameWithUpper();



// --------------------------------------------------------------------
// --- Builder methods
// --------------------------------------------------------------------

  public static interface Builder {

    /**
     * Sets the 'annotations' property of this builder.
     * @param annotations value to set
     * @return this builder
     */
    public Builder withAnnotations(eu.mihosoft.vcollections.VList annotations);
    /**
     * Sets the 'codeRange' property of this builder.
     * @param codeRange value to set
     * @return this builder
     */
    public Builder withCodeRange(eu.mihosoft.vmf.vmftext.grammar.CodeRange codeRange);
    /**
     * Sets the 'name' property of this builder.
     * @param name value to set
     * @return this builder
     */
    public Builder withName(java.lang.String name);
    /**
     * Sets the 'type' property of this builder.
     * @param type value to set
     * @return this builder
     */
    public Builder withType(eu.mihosoft.vmf.vmftext.grammar.Type type);

  /**
   * Builds a new '{@link eu.mihosoft.vmf.vmftext.grammar.Property Property}' instance.
   * @return a new '{@link eu.mihosoft.vmf.vmftext.grammar.Property Property}' instance
   */
  public Property build();

    /**
     * Defines whether to append collections rather than replacing them in the
     * {@link #applyFrom(Property)} and {@link #applyTo(Property)} methods.
     * @param value that indicates whether to append collections
     * @return this builder
     */
    public Builder appendCollections(boolean value);

    /**
     * Applies all properties from the specified object to this builder.
     * @param o object to apply properties from
     * @return this builder
     * @see #applyTo(Property)
     */
    public Builder applyFrom(Property o);

    /**
     * Applies all properties from this builder to the specified object.
     * @param o object to apply properties to
     * @return this builder
     * @see #applyFrom(Property)
     */
    public Builder applyTo(Property o);

  } // end class Builder

  /**
   * Returns a new builder for creating a '{@link eu.mihosoft.vmf.vmftext.grammar.Property Property}' instance.
   * @return a new builder for creating a '{@link eu.mihosoft.vmf.vmftext.grammar.Property Property}' instance
   */
  static Builder newBuilder() {
    return __VMF__Property_Creator.newBuilderInstance();
  } // end newBuilder()


  /**
   * Creates a new instance of '{@link Property Property}'
   * @return a new instance of '{@link Property Property}'
   */
  static Property newInstance() {

    return __VMF__Property_Creator.newInstance();


  }

  /**
   * Returns a read-only wrapper of '{@link Property Property}'
   * @return a read-only wrapper of '{@link Property Property}'
   */
  ReadOnlyProperty asReadOnly();

  /**
   * Returns a deep clone of this object.
   * @return a deep clone of this object
   */
  @Override
  Property clone() /*throws CloneNotSupportedException*/;

}

/*
 *  Creates instances of type {@codeeu.mihosoft.vmf.vmftext.grammar.impl.PropertyImpl}. Method handles
 *  and class objects are lazily initialized and cached since repetitive and high frequent usage is likely.
 *
 *  This class is used to gain efficient avvess to private classes from the impl package.
 */
class __VMF__Property_Creator {

    static Class cls;
    static java.lang.reflect.Constructor constructor;
    static java.lang.invoke.MethodHandles.Lookup lookup;
    static java.lang.invoke.MethodHandle constructorMH;

    static Property newInstance() {
        try {

            if(cls==null) {
                cls = Class.forName("eu.mihosoft.vmf.vmftext.grammar.impl.PropertyImpl");

                if(lookup==null) { lookup = java.lang.invoke.MethodHandles.lookup(); }

                constructor = cls.getConstructor();
                constructor.setAccessible(true);

                constructorMH = lookup.unreflectConstructor(constructor);
            }

            return (Property) constructorMH.invoke();

        } catch (Throwable tr) {
            throw new RuntimeException("Cannot instantiate \"eu.mihosoft.vmf.vmftext.grammar.impl.PropertyImpl\"", tr);
        }
    }

    static Class builderCls;
    static java.lang.reflect.Constructor builderConstructor;
    static java.lang.invoke.MethodHandle builderConstructorMH;

    static Property.Builder newBuilderInstance() {
        try {
            if(builderCls==null) {
                builderCls = Class.forName("eu.mihosoft.vmf.vmftext.grammar.impl.PropertyImpl$BuilderImpl");

                if(lookup==null) { lookup = java.lang.invoke.MethodHandles.lookup(); }

                builderConstructor = builderCls.getConstructor();
                builderConstructor.setAccessible(true);

                builderConstructorMH = lookup.unreflectConstructor(builderConstructor);
            }

            return (Property.Builder) builderConstructorMH.invoke();

        } catch (Throwable tr) {
            throw new RuntimeException("Cannot instantiate \"eu.mihosoft.vmf.vmftext.grammar.impl.PropertyImpl\"", tr);
        }
    }
}