/**
    * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
    * philip[at]helger[dot]com
    *
    * 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 com.helger.schematron.pure.model;
  
  import java.util.Map;
  
  import javax.annotation.Nonnull;
  
  import com.helger.commons.ValueEnforcer;
  import com.helger.commons.annotation.ReturnsMutableCopy;
  import com.helger.commons.collection.impl.ICommonsOrderedMap;
  
  /**
   * Base interface for Pure Schematron elements that support foreign attributes.
   *
   * @author Philip Helger
   */
  public interface IPSHasForeignAttributes
  {
    void addForeignAttribute (@Nonnull String sAttrName, @Nonnull String sAttrValue);
  
    default void addForeignAttributes (@Nonnull final Map <String, String> aForeignAttrs)
    {
      ValueEnforcer.notNull (aForeignAttrs, "ForeignAttrs");
      for (final Map.Entry <String, String> aEntry : aForeignAttrs.entrySet ())
        addForeignAttribute (aEntry.getKey (), aEntry.getValue ());
    }
  
    boolean hasForeignAttributes ();
  
    @Nonnull
    @ReturnsMutableCopy
    ICommonsOrderedMap <String, String> getAllForeignAttributes ();
  }