View Javadoc

1   /**
2    * LOGBack: the generic, reliable, fast and flexible logging framework.
3    * 
4    * Copyright (C) 1999-2006, QOS.ch
5    * 
6    * This library is free software, you can redistribute it and/or modify it under
7    * the terms of the GNU Lesser General Public License as published by the Free
8    * Software Foundation.
9    */
10  package ch.qos.logback.core.joran.action;
11  
12  
13  import org.xml.sax.Attributes;
14  
15  import ch.qos.logback.core.joran.spi.InterpretationContext;
16  import ch.qos.logback.core.joran.spi.Pattern;
17  
18  
19  /**
20   * ImplcitActions are like normal (explicit) actions except that are applied
21   * by the parser when no other pattern applies. Since there can be many implicit
22   * actions, each action is asked whether it applies in the given context. The
23   * first implicit action to respond positively is then applied. See also the
24   * {@link #isApplicable} method.
25   *
26   * @author Ceki Gülcü
27   */
28  public abstract class ImplicitAction extends Action {
29    
30    /**
31     * Check whether this implicit action is appropriate in the current context.
32     * 
33     * @param currentPattern This pattern contains the tag name of the current 
34     * element being parsed at the top of the stack.
35     * @param attributes The attributes of the current element to process.
36     * @param ec
37     * @return Whether the implicit action is applicable in the current context
38     */
39    public abstract boolean isApplicable(
40      Pattern currentPattern, Attributes attributes, InterpretationContext ec);
41    
42    
43  }