1 package net.sourceforge.pmd.lang.vm.directive;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. 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,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * This class implements the #stop directive which allows
24 * a user to stop the merging and rendering process. The #stop directive
25 * will accept a single message argument with info about the reason for
26 * stopping.
27 */
28 public class Stop extends Directive
29 {
30
31 /**
32 * Return name of this directive.
33 * @return The name of this directive.
34 */
35 public String getName()
36 {
37 return "stop";
38 }
39
40 /**
41 * Return type of this directive.
42 * @return The type of this directive.
43 */
44 public int getType()
45 {
46 return LINE;
47 }
48
49 /**
50 * Since there is no processing of content,
51 * there is never a need for an internal scope.
52 */
53 public boolean isScopeProvided()
54 {
55 return false;
56 }
57 }
58