KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opencms > template > cache > CmsMethodLink


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/template/cache/CmsMethodLink.java,v $
3 * Date : $Date: 2005/05/17 13:47:27 $
4 * Version: $Revision: 1.1 $
5 *
6 * This library is part of OpenCms -
7 * the Open Source Content Mananagement System
8 *
9 * Copyright (C) 2001 The OpenCms Group
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * For further information about OpenCms, please see the
22 * OpenCms Website: http://www.opencms.org
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 */
28
29 package com.opencms.template.cache;
30
31
32 /**
33  * An instance of CmsMethodLink is a link to a method. The link contains
34  * the method name and the parameter for the method.
35  *
36  * @author Hanjo Riege
37  *
38  * @deprecated Will not be supported past the OpenCms 6 release.
39  */
40 public class CmsMethodLink {
41
42     /**
43      * The name of the method to link to.
44      */
45     private String JavaDoc m_methodName;
46
47     /**
48      * The parameter for the methode.
49      */
50     private String JavaDoc m_parameter;
51
52     /**
53      * Creates a new method-Link.
54      * @param methodName - the name of the method to link to.
55      */
56     public CmsMethodLink(String JavaDoc methodName, String JavaDoc methodParameter) {
57         m_methodName = methodName;
58         m_parameter = methodParameter;
59     }
60
61     /**
62      * Returns the name of the method and the parameter.
63      * @return the name of the method with the parameter.
64      */
65     public String JavaDoc toString() {
66         return m_methodName +"("+m_parameter+")";
67     }
68
69     /**
70      * Returns the name of the method to link to.
71      * @return the name of the method to link to.
72      */
73     public String JavaDoc getMethodeName() {
74         return m_methodName;
75     }
76
77     /**
78      * Returns the parameter for the method.
79      * @return the parameter for the method.
80      */
81     public String JavaDoc getMethodParameter(){
82         return m_parameter;
83     }
84
85 }
Popular Tags