KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > services > deployment > ContextHelper


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.services.deployment;
23
24 import org.jboss.logging.Logger;
25
26 /**
27  * Helper class to pass in to velocity templates and
28  * do things that are more easily performed in java code.
29  *
30  * @author <a HREF="mailto:dimitris@jboss.org">Dimitris Andreadis</a>
31  * @version $Revision: 37459 $
32  */
33 public final class ContextHelper
34 {
35    // Static --------------------------------------------------------
36
37    /** the Logger instance */
38    private static final Logger log = Logger.getLogger(ContextHelper.class);
39    
40    // Private Data --------------------------------------------------
41
42    // Constructors --------------------------------------------------
43
44    /**
45     * Default CTOR
46     */
47    public ContextHelper()
48    {
49       // empty
50 }
51    
52    // Public --------------------------------------------------------
53
54    /**
55     * Convenience method to find out if a variable is defined (not null).
56     * This helps particularly to check if a Boolean variable has been
57     * passed to the velocity context, since the #if( $boolean )
58     * construct is only satisfied, if the value both exists and is true.
59     *
60     * @param obj any object
61     * @return true if the object is not null, false otherwise
62     */
63    public static boolean isDefined(Object JavaDoc obj)
64    {
65       return obj != null ? true : false;
66    }
67 }
68
Popular Tags