1 /**
2 * Copyright (C) 2014-2018 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.Nullable;
20
21 /**
22 * Base interface for objects having a rich group.
23 *
24 * @author Philip Helger
25 */
26 public interface IPSHasRichGroup
27 {
28 /**
29 * Overwrite any existing rich group.
30 *
31 * @param aRich
32 * The new rich group to set. May be <code>null</code>.
33 */
34 void setRich (@Nullable PSRichGroup aRich);
35
36 /**
37 * @return <code>true</code> if a rich group is present, <code>false</code>
38 * otherwise.
39 */
40 default boolean hasRich ()
41 {
42 return getRich () != null;
43 }
44
45 /**
46 * @return Get the existing rich group or <code>null</code> if none is
47 * present.
48 */
49 @Nullable
50 PSRichGroup getRich ();
51
52 /**
53 * @return Get a clone of the rich group or <code>null</code> if no rich group
54 * is present at this object.
55 */
56 @Nullable
57 default PSRichGroup getRichClone ()
58 {
59 final PSRichGroup aRich = getRich ();
60 return aRich == null ? null : aRich.getClone ();
61 }
62 }