aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DuplicateNodeDefinitionValidationModule.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *    http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.aai.schemaservice.nodeschema.validation;
  21
  22 import org.onap.aai.schemaservice.nodeschema.SchemaVersion;
  23
  24 import java.util.List;
  25
  26 /**
  27  * Defines rules for duplicate node definitions in a set of files
  28  * (where the intent is the set of files is all the OXM for one version).
  29  *
  30  * Example Options:
  31  * -Any duplicated definition found is an error
  32  * -Duplicates within a namespace are OK but not across namespaces
  33  * -Anything goes
  34  * etc.
  35  */
  36 public interface DuplicateNodeDefinitionValidationModule {
  37   /**
  38    * Finds any duplicates according to the defined rules
  39    *
  40    * @param files - the OXM files to use with full directory
  41    * @return empty String if none found, else a String
  42    *   with appropriate information about what node types
  43    *  were found
  44    */
  45   String findDuplicates(List<String> files, SchemaVersion v);
  46 }