/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package dev.metaschema.core.model.constraint.impl;
   
   import dev.metaschema.core.datatype.markup.MarkupMultiline;
   import dev.metaschema.core.metapath.IMetapathExpression;
  import dev.metaschema.core.model.ISource;
  import dev.metaschema.core.model.constraint.ILet;
  import dev.metaschema.core.qname.IEnhancedQName;
  import edu.umd.cs.findbugs.annotations.NonNull;
  import edu.umd.cs.findbugs.annotations.Nullable;
  
  /**
   * A variable assignment for use in Metaschema module constraints.
   * <p>
   * This class is immutable.
   */
  @SuppressWarnings("PMD.DataClass")
  public class DefaultLet implements ILet {
    @NonNull
    private final IEnhancedQName name;
    @NonNull
    private final IMetapathExpression valueExpression;
    @NonNull
    private final ISource source;
    @Nullable
    private final MarkupMultiline remarks;
  
    /**
     * Construct a new let statement.
     *
     * @param name
     *          the variable name
     * @param metapath
     *          the Metapath expression used to query the value
     * @param source
     *          the source of the let statement
     * @param remarks
     *          remarks about the let statement
     */
    public DefaultLet(
        @NonNull IEnhancedQName name,
        @NonNull IMetapathExpression metapath,
        @NonNull ISource source,
        @Nullable MarkupMultiline remarks) {
      this.name = name;
      this.valueExpression = metapath;
      this.source = source;
      this.remarks = remarks;
    }
  
    @Override
    public IEnhancedQName getName() {
      return name;
    }
  
    @Override
    public IMetapathExpression getValueExpression() {
      return valueExpression;
    }
  
    @Override
    @NonNull
    public ISource getSource() {
      return source;
    }
  
    @Override
    public MarkupMultiline getRemarks() {
      return remarks;
    }
  }