Unit/SONAR/Checkstyle in ONAP-REST
[policy/engine.git] / ONAP-REST / src / main / java / org / onap / policy / rest / jpa / PipConfigParam.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * ONAP-REST
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6  * Modifications Copyright (C) 2019 Nordix Foundation.
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *      http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  */
21
22 package org.onap.policy.rest.jpa;
23
24 import java.io.Serializable;
25
26 import javax.persistence.Column;
27 import javax.persistence.Entity;
28 import javax.persistence.GeneratedValue;
29 import javax.persistence.GenerationType;
30 import javax.persistence.Id;
31 import javax.persistence.JoinColumn;
32 import javax.persistence.ManyToOne;
33 import javax.persistence.NamedQuery;
34 import javax.persistence.Table;
35 import javax.persistence.Transient;
36
37 import lombok.Getter;
38 import lombok.NoArgsConstructor;
39 import lombok.Setter;
40 import lombok.ToString;
41
42 /**
43  * The persistent class for the PipConfigParams database table.
44  *
45  */
46 @Entity
47 @Table(name = "PipConfigParams")
48 @NamedQuery(name = "PipConfigParam.findAll", query = "SELECT p FROM PipConfigParam p")
49 @Getter
50 @Setter
51 @ToString
52 /**
53  * Instantiates a new PIP config param.
54  */
55 @NoArgsConstructor
56 public class PipConfigParam implements Serializable {
57     private static final long serialVersionUID = 1L;
58
59     @Id
60     @GeneratedValue(strategy = GenerationType.AUTO)
61     @Column(name = "id")
62     private int id;
63
64     @Column(name = "PARAM_NAME", nullable = false, length = 1024)
65     private String paramName;
66
67     @Column(name = "PARAM_VALUE", nullable = false, length = 2048)
68     private String paramValue;
69
70     @Column(name = "PARAM_DEFAULT", nullable = true, length = 2048)
71     private String paramDefault = null;
72
73     @Column(name = "REQUIRED", nullable = false)
74     private char required = '0';
75
76     // bi-directional many-to-one association to PipConfiguration
77     @ManyToOne
78     @JoinColumn(name = "PIP_ID")
79     private PipConfiguration pipconfiguration;
80
81     /**
82      * Instantiates a new PIP config param.
83      *
84      * @param param the param
85      */
86     public PipConfigParam(String param) {
87         this.paramName = param;
88     }
89
90     /**
91      * Instantiates a new PIP config param.
92      *
93      * @param param the param
94      * @param value the value
95      */
96     public PipConfigParam(String param, String value) {
97         this(param);
98         this.paramValue = value;
99     }
100
101     /**
102      * Instantiates a new PIP config param.
103      *
104      * @param param the param
105      */
106     public PipConfigParam(PipConfigParam param) {
107         this(param.getParamName(), param.getParamValue());
108         this.paramDefault = param.getParamDefault();
109         this.required = param.required;
110     }
111
112     /**
113      * Checks if is required.
114      *
115      * @return true, if is required
116      */
117     @Transient
118     public boolean isRequired() {
119         return this.required == '1';
120     }
121
122     /**
123      * Sets the required flag.
124      *
125      * @param required the new required flag
126      */
127     @Transient
128     public void setRequiredFlag(boolean required) {
129         if (required) {
130             this.setRequired('1');
131         } else {
132             this.setRequired('0');
133         }
134     }
135 }