com.helger.schematron.pure.model.IPSHasLets Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-schematron Show documentation

Library for validating XML documents with Schematron

There is a newer version: 5.6.5

/**
 * Copyright (C) 2014-2017 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 javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.collection.ext.ICommonsOrderedMap;

/**
 * Base interface for all objects having {@link PSLet} elements contained
 *
 * @author Philip Helger
 */
public interface IPSHasLets
{
  /**
   * Add a {@link PSLet} element.
   *
   * @param aLet
   *        The let element to be added. May not be null.
   */
  void addLet (@Nonnull PSLet aLet);

  /**
   * @return true if this object has at least on contained
   *         {@link PSLet} object.
   */
  boolean hasAnyLet ();

  /**
   * @return A list of all contained {@link PSLet} elements. Never
   *         null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllLets ();

  /**
   * @return The content of all {@link PSLet} elements as an ordered Map from
   *         name to value. The order must match the declaration order! Never
   *         null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsOrderedMap  getAllLetsAsMap ();
}