1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20 package org.apache.jsieve.commands;
21
22 import org.apache.jsieve.Arguments;
23 import org.apache.jsieve.Block;
24 import org.apache.jsieve.SieveContext;
25 import org.apache.jsieve.exception.SieveException;
26 import org.apache.jsieve.exception.StopException;
27 import org.apache.jsieve.mail.MailAdapter;
28
29 /**
30 * Class Stop implements the Stop Command as defined in RFC 3028, section 3.3.
31 */
32 public class Stop extends AbstractControlCommand {
33
34 /**
35 * Constructor for Require.
36 */
37 public Stop() {
38 super();
39 }
40
41 /**
42 * <p>
43 * Throws a StopException.
44 * </p>
45 * <p>
46 * Also,
47 *
48 * @see org.apache.jsieve.commands.AbstractCommand#executeBasic(MailAdapter,
49 * Arguments, Block, SieveContext)
50 * </p>
51 */
52 protected Object executeBasic(MailAdapter mail, Arguments arguments,
53 Block block, SieveContext context) throws SieveException {
54 throw new StopException("Stop requested");
55 }
56
57 }