/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package dev.metaschema.core.metapath.item.atomic.impl;
   
   import dev.metaschema.core.datatype.markup.IMarkupString;
   import dev.metaschema.core.metapath.item.atomic.AbstractAnyAtomicItem;
  import dev.metaschema.core.metapath.item.atomic.IMarkupItem;
  import dev.metaschema.core.metapath.item.function.IMapKey;
  import dev.metaschema.core.metapath.item.function.impl.AbstractStringMapKey;
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  /**
   * An abstract implementation of a Metapath atomic item representing a
   * markup-based data value.
   *
   * @param <TYPE>
   *          the Java type of this markup item
   */
  // FIXME: Should this be a subtype of IStringItem?
  public abstract class AbstractMarkupItem<TYPE extends IMarkupString<TYPE>>
      extends AbstractAnyAtomicItem<TYPE>
      implements IMarkupItem {
  
    /**
     * Construct a new item.
     *
     * @param value
     *          the item's data value
     */
    protected AbstractMarkupItem(@NonNull TYPE value) {
      super(value);
    }
  
    @Override
    public IMarkupString<TYPE> asMarkup() {
      return getValue();
    }
  
    @Override
    public int hashCode() {
      return asMarkup().hashCode();
    }
  
    @Override
    protected String getValueSignature() {
      return "'" + asString() + "'";
    }
  
    @Override
    public boolean equals(Object obj) {
      return this == obj
          || obj instanceof IMarkupItem && compareTo((IMarkupItem) obj) == 0;
    }
  
    @Override
    public IMapKey asMapKey() {
      return new MapKey();
    }
  
    private final class MapKey
        extends AbstractStringMapKey {
      @Override
      public IMarkupItem getKey() {
        return AbstractMarkupItem.this;
      }
  
      @Override
      public String asString() {
        return getKey().asString();
      }
    }
  }