07af97cc5cb6f88a88327917bc30bc6008f3321a
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / type / PatternConstraint.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.yangtools.yang.model.api.type;
9
10 import javax.annotation.Nullable;
11 import org.opendaylight.yangtools.yang.model.api.ConstraintMetaDefinition;
12
13 /**
14  * Contains the method for getting the data from the YANG <code>pattern</code>
15  * which is substatement of <code>type</code> statement.
16  *
17  */
18 public interface PatternConstraint extends ConstraintMetaDefinition {
19
20     /**
21      * Returns a regular expression (pattern).
22      *
23      * @return string with regular expression which is equal to the argument of
24      *         the YANG <code>pattern</code> substatement
25      */
26     String getRegularExpression();
27
28     /**
29      * All implementations should override this method.
30      * The default definition of this method is used only in YANG 1.0 (RFC6020)
31      * implementations of PatternConstraint which do not support modifier statement.
32      * YANG pattern statement has been changed in YANG 1.1 (RFC7950) and now allows modifier statement.
33      *
34      * @return enum constant which represents the value of modifier statement
35      */
36      // FIXME: version 2.0.0: make this method non-default
37     @Nullable default ModifierKind getModifier() {
38         return null;
39     }
40 }