1 /**
2 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
3 * philip[at]helger[dot]com
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package com.helger.schematron.pure.model;
18
19 import javax.annotation.Nonnull;
20
21 import com.helger.commons.annotation.ReturnsMutableCopy;
22 import com.helger.commons.collection.ext.ICommonsList;
23
24 /**
25 * Base interface for Pure Schematron elements that support includes.
26 *
27 * @author Philip Helger
28 */
29 public interface IPSHasIncludes
30 {
31 /**
32 * Add an include to this object.
33 *
34 * @param aInclude
35 * The include to be added. May not be <code>null</code>.
36 */
37 void addInclude (@Nonnull PSInclude aInclude);
38
39 /**
40 * @return <code>true</code> if at least one include is present in this
41 * object.
42 */
43 boolean hasAnyInclude ();
44
45 /**
46 * @return A list of all contained includes. Never <code>null</code>.
47 */
48 @Nonnull
49 @ReturnsMutableCopy
50 ICommonsList <PSInclude> getAllIncludes ();
51 }