Source code

001/*
002 * Copyright (C) 2009-2011 Mathias Doenitz
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.parboiled.annotations;
018
019import org.parboiled.Rule;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Annotation that can be used on parser methods returning {@link Rule}s and having parameters.
028 * Instructs parboiled to automatically cache the method return value for the parameters it was created with.
029 * Note that all parser methods returning {@link Rule} objects and <b>not</b> taking any parameter are
030 * automatically cached and are therefore not allowed to carry this annotation.
031 */
032@Retention(RetentionPolicy.RUNTIME)
033@Target({ElementType.METHOD})
034public @interface Cached {
035}