FlexPMD/flex-pmd-java/flex-pmd-ruleset/src/main/java/com/adobe/ac/pmd/rules/asdocs/AbstractAsDocRule.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package com.adobe.ac.pmd.rules.asdocs;

import com.adobe.ac.pmd.nodes.IAsDocHolder;
import com.adobe.ac.pmd.rules.core.AbstractAstFlexRule;

abstract class AbstractAsDocRule extends AbstractAstFlexRule
{
   /**
    * @param asDocHolder
    */
   protected void addViolationIfAsDocMissing( final IAsDocHolder asDocHolder )
   {
      if ( asDocHolder.getAsDoc() == null )
      {
         addViolation( asDocHolder );
      }
   }
}