// =================== DO NOT EDIT THIS FILE ====================
   //  Generated by Modello Velocity from model.vm
   //  template, any modifications will be overwritten.
   // ==============================================================
   package org.apache.maven.api.plugin.descriptor;
   
   import java.io.Serializable;
   import java.util.Collections;
   import java.util.HashMap;
  import java.util.Map;
  import java.util.Objects;
  import java.util.Optional;
  import java.util.Set;
  import java.util.stream.Collectors;
  import java.util.stream.Stream;
  import org.apache.maven.api.annotations.Experimental;
  import org.apache.maven.api.annotations.Generated;
  import org.apache.maven.api.annotations.Immutable;
  import org.apache.maven.api.annotations.Nonnull;
  import org.apache.maven.api.annotations.NotThreadSafe;
  import org.apache.maven.api.annotations.ThreadSafe;
  
  /**
   * Describes a component requirement.
   */
  @Experimental
  @Generated @ThreadSafe @Immutable
  public class Requirement
      implements Serializable
  {
      /**
       * 
       */
      final String role;
      /**
       * 
       */
      final String roleHint;
      /**
       * The field name which has this requirement.
       */
      final String fieldName;
  
      /**
        * Constructor for this class, to be called from its subclasses and {@link Builder}.
        * @see Builder#build()
        */
      protected Requirement(Builder builder) {
          this.role = builder.role != null ? builder.role : (builder.base != null ? builder.base.role : null);
          this.roleHint = builder.roleHint != null ? builder.roleHint : (builder.base != null ? builder.base.roleHint : null);
          this.fieldName = builder.fieldName != null ? builder.fieldName : (builder.base != null ? builder.base.fieldName : null);
      }
  
      /**
       * 
       *
       * @return a {@code String}
       */
      public String getRole() {
          return this.role;
      }
  
      /**
       * 
       *
       * @return a {@code String}
       */
      public String getRoleHint() {
          return this.roleHint;
      }
  
      /**
       * The field name which has this requirement.
       *
       * @return a {@code String}
       */
      public String getFieldName() {
          return this.fieldName;
      }
  
      /**
       * Creates a new builder with this object as the basis.
       *
       * @return a {@code Builder}
       */
      @Nonnull
      public Builder with() {
          return newBuilder(this);
      }
      /**
       * Creates a new {@code Requirement} instance using the specified role.
       *
       * @param role the new {@code String} to use
       * @return a {@code Requirement} with the specified role
       */
      @Nonnull
      public Requirement withRole(String role) {
          return newBuilder(this, true).role(role).build();
      }
     /**
      * Creates a new {@code Requirement} instance using the specified roleHint.
      *
      * @param roleHint the new {@code String} to use
      * @return a {@code Requirement} with the specified roleHint
      */
     @Nonnull
     public Requirement withRoleHint(String roleHint) {
         return newBuilder(this, true).roleHint(roleHint).build();
     }
     /**
      * Creates a new {@code Requirement} instance using the specified fieldName.
      *
      * @param fieldName the new {@code String} to use
      * @return a {@code Requirement} with the specified fieldName
      */
     @Nonnull
     public Requirement withFieldName(String fieldName) {
         return newBuilder(this, true).fieldName(fieldName).build();
     }
 
     /**
      * Creates a new {@code Requirement} instance.
      * Equivalent to {@code newInstance(true)}.
      * @see #newInstance(boolean)
      *
      * @return a new {@code Requirement}
      */
     @Nonnull
     public static Requirement newInstance() {
         return newInstance(true);
     }
 
     /**
      * Creates a new {@code Requirement} instance using default values or not.
      * Equivalent to {@code newBuilder(withDefaults).build()}.
      *
      * @param withDefaults the boolean indicating whether default values should be used
      * @return a new {@code Requirement}
      */
     @Nonnull
     public static Requirement newInstance(boolean withDefaults) {
         return newBuilder(withDefaults).build();
     }
 
     /**
      * Creates a new {@code Requirement} builder instance.
      * Equivalent to {@code newBuilder(true)}.
      * @see #newBuilder(boolean)
      *
      * @return a new {@code Builder}
      */
     @Nonnull
     public static Builder newBuilder() {
         return newBuilder(true);
     }
 
     /**
      * Creates a new {@code Requirement} builder instance using default values or not.
      *
      * @param withDefaults the boolean indicating whether default values should be used
      * @return a new {@code Builder}
      */
     @Nonnull
     public static Builder newBuilder(boolean withDefaults) {
         return new Builder(withDefaults);
     }
 
     /**
      * Creates a new {@code Requirement} builder instance using the specified object as a basis.
      * Equivalent to {@code newBuilder(from, false)}.
      *
      * @param from the {@code Requirement} instance to use as a basis
      * @return a new {@code Builder}
      */
     @Nonnull
     public static Builder newBuilder(Requirement from) {
         return newBuilder(from, false);
     }
 
     /**
      * Creates a new {@code Requirement} builder instance using the specified object as a basis.
      *
      * @param from the {@code Requirement} instance to use as a basis
      * @param forceCopy the boolean indicating if a copy should be forced
      * @return a new {@code Builder}
      */
     @Nonnull
     public static Builder newBuilder(Requirement from, boolean forceCopy) {
         return new Builder(from, forceCopy);
     }
 
     /**
      * Builder class used to create Requirement instances.
      * @see #with()
      * @see #newBuilder()
      */
     @NotThreadSafe
     public static class Builder
     {
         Requirement base;
         String role;
         String roleHint;
         String fieldName;
 
         protected Builder(boolean withDefaults) {
             if (withDefaults) {
             }
         }
 
         protected Builder(Requirement base, boolean forceCopy) {
             if (forceCopy) {
                 this.role = base.role;
                 this.roleHint = base.roleHint;
                 this.fieldName = base.fieldName;
             } else {
                 this.base = base;
             }
         }
 
         @Nonnull
         public Builder role(String role) {
             this.role = role;
             return this;
         }
 
         @Nonnull
         public Builder roleHint(String roleHint) {
             this.roleHint = roleHint;
             return this;
         }
 
         @Nonnull
         public Builder fieldName(String fieldName) {
             this.fieldName = fieldName;
             return this;
         }
 
 
         @Nonnull
         public Requirement build() {
             // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
             if (base != null
                     && (role == null || role == base.role)
                     && (roleHint == null || roleHint == base.roleHint)
                     && (fieldName == null || fieldName == base.fieldName)
             ) {
                 return base;
             }
             return new Requirement(this);
         }
 
     }
 
 }