/*
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software
    * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.basepom.mojo.propertyhelper.definitions;
  
  import static com.google.common.base.Preconditions.checkNotNull;
  import static com.google.common.base.Preconditions.checkState;
  
  import org.basepom.mojo.propertyhelper.FieldContext;
  import org.basepom.mojo.propertyhelper.ValueCache;
  import org.basepom.mojo.propertyhelper.ValueProvider;
  import org.basepom.mojo.propertyhelper.fields.MacroField;
  
  import java.io.IOException;
  import java.util.Map;
  import java.util.Objects;
  import java.util.Optional;
  import java.util.Properties;
  import java.util.StringJoiner;
  
  import com.google.common.annotations.VisibleForTesting;
  import com.google.common.collect.ImmutableMap;
  import com.google.common.collect.Maps;
  
  /**
   * Represents a macro configuration in the POM.
   */
  public class MacroDefinition extends FieldDefinition<String> {
  
      /**
       * Macro type. This value is used to look up a plexus component with this value as hint. Field injected by Maven.
       */
      String macroType = null;
  
      /**
       * Class for this macro. If no macro type is given and this value is provided, the plugin will try to instantiate this class. Field injected by Maven.
       */
      String macroClass = null;
  
      /**
       * Macro specific properties. Field injected by Maven.
       */
      Properties properties = new Properties();
  
      public MacroDefinition() {
      }
  
      @VisibleForTesting
      MacroDefinition(String id) {
          super(id);
      }
  
      public Optional<String> getMacroType() {
          return Optional.ofNullable(macroType);
      }
  
      public Optional<String> getMacroClass() {
          return Optional.ofNullable(macroClass);
      }
  
      public Map<String, String> getProperties() {
          return ImmutableMap.copyOf(Maps.fromProperties(properties));
      }
  
      @Override
      public void check() {
          super.check();
  
          checkState(macroClass != null || macroType != null, "neither macro class nor macro type is defined!");
      }
  
      @Override
      public MacroField createField(FieldContext context, ValueCache valueCache) throws IOException {
          checkNotNull(context, "context is null");
          checkNotNull(valueCache, "valueCache is null");
  
          check();
  
          final ValueProvider macroValue = valueCache.getValueProvider(this);
          return new MacroField(this, macroValue, context);
      }
  
      @Override
      public String toString() {
          return new StringJoiner(", ", MacroDefinition.class.getSimpleName() + "[", "]")
              .add("macroType='" + macroType + "'")
              .add("macroClass='" + macroClass + "'")
              .add("properties=" + properties)
             .add(super.toString())
             .toString();
     }
 
     @Override
     public boolean equals(Object o) {
         if (this == o) {
             return true;
         }
         if (o == null || getClass() != o.getClass()) {
             return false;
         }
         if (!super.equals(o)) {
             return false;
         }
         MacroDefinition that = (MacroDefinition) o;
         return Objects.equals(macroType, that.macroType) && Objects.equals(macroClass, that.macroClass) && Objects.equals(properties,
             that.properties);
     }
 
     @Override
     public int hashCode() {
         return Objects.hash(super.hashCode(), macroType, macroClass, properties);
     }
 }