View Javadoc

    1   /*
    2    * Copyright 2002,2004 The Apache Software Foundation.
    3    *
    4    * Licensed under the Apache License, Version 2.0 (the "License");
    5    * you may not use this file except in compliance with the License.
    6    * You may obtain a copy of the License at
    7    *
    8    *      http://www.apache.org/licenses/LICENSE-2.0
    9    *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16
    17  package org.apache.commons.jexl.util.introspection;
    18
    19
    20  /***
    21   *  Interface defining a 'getter'.  For uses when looking for resolution of
    22   *  property references
    23   *
    24   *       $foo.bar
    25   *
    26   * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
    27   * @version $Id: VelPropertyGet.java,v 1.3 2004/02/28 13:45:22 yoavs Exp $
    28   */
    29  public interface VelPropertyGet
    30  {
    31      /***
    32       *  invocation method - called when the 'get action' should be
    33       *  preformed and a value returned
    34       */
    35      public Object invoke(Object o) throws Exception;
    36
    37      /***
    38       *  specifies if this VelPropertyGet is cacheable and able to be
    39       *  reused for this class of object it was returned for
    40       *
    41       *  @return true if can be reused for this class, false if not
    42       */
    43      public boolean isCacheable();
    44
    45      /***
    46       *  returns the method name used to return this 'property'
    47       */
    48      public String getMethodName();
    49  }