You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by ge...@apache.org on 2002/04/21 20:37:50 UTC

cvs commit: jakarta-velocity/src/java/org/apache/velocity/util/introspection Uberspect.java UberspectLoggable.java

geirm       02/04/21 11:37:50

  Added:       src/java/org/apache/velocity/util/introspection
                        Uberspect.java UberspectLoggable.java
  Log:
  Two interfaces for the 'federated' introspection.
  
  Uberspect : the main interface used by the vel internals to get iterators,
  getters/settors, and methods
  
  UberspectLogger : marker interface for setting a logger for an impl
  
  Revision  Changes    Path
  1.1                  jakarta-velocity/src/java/org/apache/velocity/util/introspection/Uberspect.java
  
  Index: Uberspect.java
  ===================================================================
  package org.apache.velocity.util.introspection;
  
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Velocity", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import org.apache.velocity.runtime.RuntimeLogger;
  
  import java.util.Iterator;
  import java.lang.reflect.Method;
  
  /**
   * 'Federated' introspection/reflection interface to allow the introspection
   *  behavior in Velocity to be customized.
   *
   * @author <a href="mailto:geirm@apache.org">Geir Magusson Jr.</a>
   * @version $Id: Uberspect.java,v 1.1 2002/04/21 18:37:50 geirm Exp $
   */
  public interface Uberspect
  {
      /**
       *  Initializer - will be called before use
       */
      public void init() throws Exception;
  
      /**
       *  To support iteratives - #foreach()
       */
      public Iterator getIterator(Object obj, Info info) throws Exception;
  
      /**
       *  Returns a general method, corresponding to $foo.bar( $woogie )
       */
      public VelMethod getMethod(Object obj, String method, Object[] args, Info info) throws Exception;
  
      /**
       * Property getter - returns VelPropertyGet appropos for #set($foo = $bar.woogie)
       */
      public VelPropertyGet getPropertyGet(Object obj, String identifier, Info info) throws Exception;
  
      /**
       * Property setter - returns VelPropertySet appropos for #set($foo.bar = "geir")
       */
      public VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info info) throws Exception;
  }
  
  
  
  1.1                  jakarta-velocity/src/java/org/apache/velocity/util/introspection/UberspectLoggable.java
  
  Index: UberspectLoggable.java
  ===================================================================
  package org.apache.velocity.util.introspection;
  
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Velocity", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import org.apache.velocity.runtime.RuntimeLogger;
  
  /**
   *  Marker interface to let an uberspector indicate it can and wants to
   *  log
   *
   *  Thanks to Paulo for the suggestion
   *
   * @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
   * @version $Id: UberspectLoggable.java,v 1.1 2002/04/21 18:37:50 geirm Exp $
   *
   */
  public interface UberspectLoggable
  {
      /**
       *  Sets the logger.  This will be called before any calls to the
       *  uberspector
       */
      public void setRuntimeLogger(RuntimeLogger logger);
  }
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>