/**
    * This file Copyright (c) 2015-2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.config.registry;
  
  import info.magnolia.config.source.Deprecation;
  import info.magnolia.config.source.ConfigurationSourceType;
  
  import java.util.Optional;
  
  import lombok.AllArgsConstructor;
  import lombok.Getter;
  import lombok.Value;
  
  /**
   * DefinitionMetadataBuilder are used to progressively populate metadata for a {@link DefinitionProvider}. For example,
   * the name() method could be called several times before a provider is registered in a {@link info.magnolia.config.registry.Registry}.
   * They are also responsible for determining the referenceId string used by the registries. Implement your own, or use
   * one of the static factory methods.
   * @see #usingModuleAndRelativePathAsId()
   * @see #usingNameAsId()
   */
  @Getter
  public abstract class DefinitionMetadataBuilder {
      /**
       * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the <module-name>:<relative-location> form.
       */
      public static DefinitionMetadataBuilder usingModuleAndRelativePathAsId() {
          return new ModuleAndRelativePathMetadataBuilder();
      }
  
      /**
       * A convenience static factory method which returns a DefinitionMetadataBuilder which generates referenceId using the name property.
       */
      public static DefinitionMetadataBuilder usingNameAsId() {
          return new NameMetadataBuilder();
      }
  
      private static class ModuleAndRelativePathMetadataBuilder extends DefinitionMetadataBuilder {
          @Override
          protected String buildReferenceId() {
              return getModule() + ":" + getRelativeLocation();
          }
      }
  
      private static class NameMetadataBuilder extends DefinitionMetadataBuilder {
          @Override
          protected String buildReferenceId() {
              return getName();
          }
      }
  
      private DefinitionType type;
      private String name;
      private String module;
      private String location;
      private String relativeLocation;
      private ConfigurationSourceType configurationSourceType;
      private Deprecation deprecation;
  
      protected DefinitionMetadataBuilder() {
      }
  
      public DefinitionMetadataBuilder type(DefinitionType type) {
          this.type = type;
          return this;
      }
  
      public DefinitionMetadataBuilder name(String name) {
         this.name = name;
         return this;
     }
 
     public DefinitionMetadataBuilder module(String module) {
         this.module = module;
         return this;
     }
 
     public DefinitionMetadataBuilder location(String location) {
         this.location = location;
         return this;
     }
 
     public DefinitionMetadataBuilder relativeLocation(String relativeLocation) {
         this.relativeLocation = relativeLocation;
         return this;
     }
 
     public DefinitionMetadataBuilder configurationSourceType(ConfigurationSourceType configurationSourceType) {
         this.configurationSourceType = configurationSourceType;
         return this;
     }
 
     public DefinitionMetadataBuilder deprecation(Deprecation deprecation) {
         this.deprecation = deprecation;
         return this;
     }
 
     public DefinitionMetadata build() {
         final String referenceId = buildReferenceId();
         return new DefinitionMetadataImpl(this.type, referenceId, this.name, this.module, this.location, this.relativeLocation,
                 this.configurationSourceType, this.deprecation);
     }
 
     protected abstract String buildReferenceId();
 
     /**
      * Implementation of {@link info.magnolia.config.registry.DefinitionMetadata}.
      */
     @Value
     @AllArgsConstructor
     public static class DefinitionMetadataImpl implements DefinitionMetadata {
         private final DefinitionType type;
         private final String referenceId;
         private final String name;
         private final String module;
         private final String location;
         private final String relativeLocation;
         private final ConfigurationSourceType configurationSourceType;
         private final Deprecation deprecation;
 
         @Override
         public String toString() {
             String metadataString = String.format("[%s] definition [%s] with reference id: [%s] from module [%s] at [%s]",
                     type.getName(), name, referenceId, module, relativeLocation);
             if (deprecation != null) {
                 metadataString += metadataString + String.format(" which is deprecated %s", deprecation);
             }
             return metadataString;
         }
 
         public Optional<Deprecation> getDeprecation() {
             return Optional.ofNullable(deprecation);
         }
     }
 
 }