01: /****************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one *
03: * or more contributor license agreements. See the NOTICE file *
04: * distributed with this work for additional information *
05: * regarding copyright ownership. The ASF licenses this file *
06: * to you under the Apache License, Version 2.0 (the *
07: * "License"); you may not use this file except in compliance *
08: * with the License. You may obtain a copy of the License at *
09: * *
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: ****************************************************************/package org.apache.james.jspf.parser;
19:
20: import java.util.regex.Pattern;
21:
22: /**
23: * A term definition contains everything needed to match and create
24: * new Terms implementations.
25: */
26: public interface TermDefinition {
27:
28: /**
29: * Retrieve the pattern to be used to match a string against this record type.
30: *
31: * @return the pattern for this term
32: */
33: public Pattern getPattern();
34:
35: /**
36: * The class implementing this Term type.
37: *
38: * @return the class object.
39: */
40: public Class getTermDef();
41:
42: /**
43: * Return the number of groups to be expected from the pattern of this
44: * Term.
45: *
46: * @return the number of groups
47: */
48: public int getMatchSize();
49:
50: }
|