com.phloc.schematron.pure.model.IPSHasLinkableGroup Maven / Gradle / Ivy

Go to download

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

Library for validating XML documents with Schematron

There is a newer version: 2.7.1

/**
 * Copyright (C) 2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.schematron.pure.model;

import javax.annotation.Nullable;

/**
 * Base interface for objects having a linkable group.
 * 
 * @author Philip Helger
 */
public interface IPSHasLinkableGroup
{
  /**
   * Overwrite any existing linkable group.
   * 
   * @param aLinkable
   *        The new linkable group to set. May be null.
   */
  void setLinkable (@Nullable PSLinkableGroup aLinkable);

  /**
   * @return true if a linkable group is present,
   *         false otherwise.
   */
  boolean hasLinkable ();

  /**
   * @return Get the existing linkable group or null if none is
   *         present.
   */
  @Nullable
  PSLinkableGroup getLinkable ();

  /**
   * @return Get a clone of the linkable group or null if no
   *         linkable group is present at this object.
   */
  @Nullable
  PSLinkableGroup getLinkableClone ();
}