KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > fn > string > FormatValue


1 // ============================================================================
2 // $Id: FormatValue.java,v 1.7 2006/01/08 00:52:25 davidahall Exp $
3 // Copyright (c) 2003-2005 David A. Hall
4 // ============================================================================
5 // The contents of this file are subject to the Common Development and
6 // Distribution License (CDDL), Version 1.0 (the License); you may not use this
7 // file except in compliance with the License. You should have received a copy
8 // of the the License along with this file: if not, a copy of the License is
9 // available from Sun Microsystems, Inc.
10 //
11 // http://www.sun.com/cddl/cddl.html
12 //
13 // From time to time, the license steward (initially Sun Microsystems, Inc.) may
14 // publish revised and/or new versions of the License. You may not use,
15 // distribute, or otherwise make this file available under subsequent versions
16 // of the License.
17 //
18 // Alternatively, the contents of this file may be used under the terms of the
19 // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
20 // case the provisions of the LGPL are applicable instead of those above. If you
21 // wish to allow use of your version of this file only under the terms of the
22 // LGPL, and not to allow others to use your version of this file under the
23 // terms of the CDDL, indicate your decision by deleting the provisions above
24 // and replace them with the notice and other provisions required by the LGPL.
25 // If you do not delete the provisions above, a recipient may use your version
26 // of this file under the terms of either the CDDL or the LGPL.
27 //
28 // This library is distributed in the hope that it will be useful,
29 // but WITHOUT ANY WARRANTY; without even the implied warranty of
30 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
31 // ============================================================================
32 package net.sf.jga.fn.string;
33
34 import java.text.Format JavaDoc;
35 import net.sf.jga.fn.UnaryFunctor;
36
37 /**
38  * Unary Functor that generates a formatted string for a given value.
39  * <p>
40  * Copyright &copy; 2003-2005 David A. Hall
41  *
42  * @author <a HREF="mailto:davidahall@users.sf.net">David A. Hall</a>
43  */
44
45 public class FormatValue<T> extends UnaryFunctor<T,String JavaDoc> {
46     
47     static final long serialVersionUID = -6545061527457884949L;
48
49     private Format JavaDoc _format;
50     
51     public FormatValue (Format JavaDoc format){
52         if (format == null) {
53             String JavaDoc msg = "Format must be specified";
54             throw new IllegalArgumentException JavaDoc(msg);
55         }
56         
57         _format = format;
58     }
59
60     /**
61      * Returns the format object used to present values in formatted form.
62      * @return the format used to present values
63      */
64     
65     public Format JavaDoc getFormat() {
66         return _format;
67     }
68     
69     // UnaryFunctor interface
70
71     /**
72      * Formats the argument using the java.text.Format given at construction.
73      * <p>
74      * @param arg the value to formatted
75      * @return the formatted value
76      */
77
78     public String JavaDoc fn(T arg) {
79         return _format.format(arg);
80     }
81     
82     /**
83      * Calls the Visitor's <code>visit(FormatValue)</code> method, if it
84      * implements the nested Visitor interface.
85      */
86     public void accept(net.sf.jga.fn.Visitor v) {
87         if (v instanceof FormatValue.Visitor)
88             ((FormatValue.Visitor)v).visit(this);
89         else
90             v.visit(this);
91     }
92
93     // Object overrides
94
95     public String JavaDoc toString() {
96         return "FormatValue["+_format+"]";
97     }
98     
99     // Acyclic Visitor
100
101     /**
102      * Interface for classes that may interpret a <b>FormatValue</b>
103      * predicate.
104      */
105     public interface Visitor extends net.sf.jga.fn.Visitor {
106         public void visit(FormatValue host);
107     }
108 }
109
Popular Tags