View Javadoc

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;
21  
22  /***
23   * Context for sieve operations.
24   *
25   */
26  public abstract class SieveContext {
27  
28      /***
29       * Gets the script position of the current operation.
30       * @return <code>ScriptCoordinate</code>, not null
31       */
32      public abstract ScriptCoordinate getCoordinate();
33      
34      /***
35       * Sets the script position of the current operation.
36       * @param coordinate <code>ScriptCoordinate</code>, not null
37       */
38      public abstract void setCoordinate(ScriptCoordinate coordinate);
39  }