Stop.java

package net.sourceforge.pmd.lang.vm.directive;

/*
 * 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.    
 */

/**
 * This class implements the #stop directive which allows a user to stop the
 * merging and rendering process. The #stop directive will accept a single
 * message argument with info about the reason for stopping.
 */
public class Stop extends Directive {

    /**
     * Return name of this directive.
     * 
     * @return The name of this directive.
     */
    public String getName() {
        return "stop";
    }

    /**
     * Return type of this directive.
     * 
     * @return The type of this directive.
     */
    public int getType() {
        return LINE;
    }

    /**
     * Since there is no processing of content, there is never a need for an
     * internal scope.
     */
    public boolean isScopeProvided() {
        return false;
    }
}