/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package dev.metaschema.core.metapath.item.atomic;
   
   import dev.metaschema.core.datatype.markup.IMarkupString;
   import dev.metaschema.core.datatype.markup.MarkupDataTypeProvider;
  import dev.metaschema.core.metapath.function.InvalidValueForCastFunctionException;
  import dev.metaschema.core.metapath.type.IAtomicOrUnionType;
  import dev.metaschema.core.metapath.type.InvalidTypeMetapathException;
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  /**
   * An atomic Metapath item representing a Markup data value.
   */
  public interface IMarkupItem extends IAnyAtomicItem {
    /**
     * Get the type information for this item.
     *
     * @return the type information
     */
    @NonNull
    static IAtomicOrUnionType<IMarkupItem> type() {
      return MarkupDataTypeProvider.MARKUP_TYPE;
    }
  
    @Override
    default IAtomicOrUnionType<? extends IMarkupItem> getType() {
      return type();
    }
  
    /**
     * Cast the provided type to this item type.
     *
     * @param item
     *          the item to cast
     * @return the original item if it is already this type, otherwise a new item
     *         cast to this type
     * @throws InvalidValueForCastFunctionException
     *           if the provided {@code item} cannot be cast to this type
     */
    @NonNull
    static IMarkupItem cast(@NonNull IAnyAtomicItem item) {
      try {
        return item instanceof IMarkupItem
            ? (IMarkupItem) item
            : IMarkupMultilineItem.valueOf(item.asString());
      } catch (IllegalStateException | InvalidTypeMetapathException ex) {
        // asString can throw IllegalStateException exception
        throw new InvalidValueForCastFunctionException(ex);
      }
    }
  
    /**
     * Get the "wrapped" markup value.
     *
     * @return the underlying markup value
     */
    @NonNull
    IMarkupString<?> asMarkup();
  
    @Override
    default IMarkupItem castAsType(IAnyAtomicItem item) {
      return cast(item);
    }
  
    /**
     * Compares this value with the argument.
     *
     * @param item
     *          the item to compare with this value
     * @return a negative integer, zero, or a positive integer if this value is less
     *         than, equal to, or greater than the {@code item}.
     */
    default int compareTo(@NonNull IMarkupItem item) {
      return asString().compareTo(item.asString());
    }
  }