diff options
Diffstat (limited to 'controlloop/common/policy-yaml')
5 files changed, 36 insertions, 7 deletions
diff --git a/controlloop/common/policy-yaml/checkstyle-suppressions.xml b/controlloop/common/policy-yaml/checkstyle-suppressions.xml new file mode 100644 index 000000000..a23b257a6 --- /dev/null +++ b/controlloop/common/policy-yaml/checkstyle-suppressions.xml @@ -0,0 +1,30 @@ +<?xml version="1.0"?> +<!-- + ============LICENSE_START======================================================= + Copyright (C) 2018 AT&T Technologies. All rights reserved. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + SPDX-License-Identifier: Apache-2.0 + ============LICENSE_END========================================================= +--> + +<!DOCTYPE suppressions PUBLIC + "-//Puppy Crawl//DTD Suppressions 1.0//EN" + "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> + +<suppressions> + <suppress checks="AbbreviationAsWordInName" + files="ControlLoopCompiler.java|Target.java|ControlLoopPolicyBuilder.java" + lines="1-9999"/> +</suppressions> diff --git a/controlloop/common/policy-yaml/pom.xml b/controlloop/common/policy-yaml/pom.xml index b48e74d67..6594817ef 100644 --- a/controlloop/common/policy-yaml/pom.xml +++ b/controlloop/common/policy-yaml/pom.xml @@ -104,12 +104,13 @@ with minor changes --> <configLocation>onap-checkstyle/onap-java-style.xml</configLocation> <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory --> - <sourceDirectory>${project.build.sourceDirectory}/src/main/java</sourceDirectory> + <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory> <includeResources>true</includeResources> <includeTestSourceDirectory>true</includeTestSourceDirectory> <includeTestResources>true</includeTestResources> <excludes> </excludes> + <suppressionsLocation>${project.basedir}/checkstyle-suppressions.xml</suppressionsLocation> <consoleOutput>true</consoleOutput> <failsOnViolation>true</failsOnViolation> <violationSeverity>warning</violationSeverity> @@ -127,5 +128,4 @@ </plugin> </plugins> </build> - </project> diff --git a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/compiler/ControlLoopCompiler.java b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/compiler/ControlLoopCompiler.java index 45ff1847b..76c6f8f14 100644 --- a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/compiler/ControlLoopCompiler.java +++ b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/compiler/ControlLoopCompiler.java @@ -74,8 +74,7 @@ public class ControlLoopCompiler implements Serializable { * * @param yamlSpecification the yaml input stream * @param callback method to callback during compilation - * @return - * + * @return Control Loop object * @throws CompilerException throws any compile exception found */ public static ControlLoopPolicy compile(InputStream yamlSpecification, diff --git a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/builder/ControlLoopPolicyBuilder.java b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/builder/ControlLoopPolicyBuilder.java index 9d00793b9..8ea33d5f0 100644 --- a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/builder/ControlLoopPolicyBuilder.java +++ b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/builder/ControlLoopPolicyBuilder.java @@ -235,7 +235,7 @@ public interface ControlLoopPolicyBuilder { /** * Removes all existing Operational Policies and reverts back to an Open Loop. * - * @return + * @return Policy builder object */ public ControlLoopPolicyBuilder removeAllPolicies(); diff --git a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/guard/Constraint.java b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/guard/Constraint.java index b54e2f665..5ac1fdc91 100644 --- a/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/guard/Constraint.java +++ b/controlloop/common/policy-yaml/src/main/java/org/onap/policy/controlloop/policy/guard/Constraint.java @@ -55,8 +55,8 @@ public class Constraint { /** * Constructor. * - * @param minVNFLimit minimum VNF count - * @param maxVNFLimit maximum VNF count + * @param minVnfCount minimum VNF count + * @param maxVnfCount maximum VNF count * @param activeTimeRange active time range */ public Constraint(Integer minVnfCount, Integer maxVnfCount, Map<String, String> activeTimeRange) { |