Merge "Add period after inheritDoc for Sonar"
[policy/apex-pdp.git] / client / client-editor / src / main / java / org / onap / policy / apex / client / editor / rest / handling / bean / BeanField.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
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  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.apex.client.editor.rest.handling.bean;
22
23 import javax.xml.bind.annotation.XmlType;
24
25 /**
26  * The Field Bean.
27  */
28 @XmlType
29 public class BeanField extends BeanKeyRef {
30
31     private boolean optional = true;
32     private String localName = null;
33
34     /**
35      * Gets the local name for this field.
36      *
37      * @return the local name for this field.
38      */
39     public String getLocalName() {
40         return localName;
41     }
42
43     /**
44      * Gets the optional flag.
45      *
46      * @return the optional flag
47      */
48     public boolean getOptional() {
49         return optional;
50     }
51
52     /*
53      * (non-Javadoc)
54      *
55      * @see org.onap.policy.apex.client.editor.rest.bean.Bean_KeyRef#toString()
56      */
57     @Override
58     public String toString() {
59         return "Field [localName=" + getLocalName() + ", name=" + getName() + ", version=" + getVersion()
60                 + ", optional=" + getOptional() + "]";
61     }
62
63 }