KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > core > util > byteable > ByteableText


1 /*
2  * Copyright 2002 by
3  * <a HREF="http://www.coridan.com">Coridan</a>
4  * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5  *
6  * The contents of this file are subject to the Mozilla Public License Version
7  * 1.1 (the "License"); you may not use this file except in compliance with the
8  * License. You may obtain a copy of the License at
9  * http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is "MantaRay" (TM).
17  *
18  * The Initial Developer of the Original Code is Amir Shevat.
19  * Portions created by the Initial Developer are Copyright (C) 2006
20  * Coridan Inc. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source
23  * code where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34  
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Lesser General Public License as published by the Free Software Foundation;
39  * either version 2.1 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44  * License for more details.
45  */
46 /*
47  * Created on Feb 12, 2004
48  * Manta LTD
49  */
50 package org.mr.core.util.byteable;
51
52 import java.io.IOException JavaDoc;
53
54 /**
55  * ByteableText - do not use if you do not have to , if you are using any other byteable object
56  * it is better practise to have the text as a member of your byteable object and use the
57  * use writeUTF and readUTF or other string writing tool the ByteableOut/InputStream gives you
58  *
59  * the only time useing a ByteableText is a good idia is when it is the only payload you want to transfer/save
60  *
61  * this object encapsulates a String to be sent on the net or saved in a file
62  * this object used to be byteableString and it is still undergoing improvments
63  *
64  * @since Feb 12, 2004
65  * @version 1.1
66  * @author Amir Shevat
67  *
68  */
69 public class ByteableText implements Byteable {
70
71     private String JavaDoc underLine;
72     
73     /**
74      * @param underLine the underline string of this object
75      */
76     public ByteableText(String JavaDoc underLine ) {
77         this.underLine =underLine;
78     }
79
80     /* (non-Javadoc)
81      * @see org.mr.core.util.byteable.Byteable#getByteableName()
82      */
83     public String JavaDoc getByteableName() {
84         
85         return "BText";
86     }
87
88     /* (non-Javadoc)
89      * @see org.mr.core.util.byteable.Byteable#toBytes(org.mr.core.util.byteable.ByteableOutputStream)
90      */
91     public void toBytes(ByteableOutputStream out) throws IOException JavaDoc {
92         out.writeUTF(underLine);
93
94     }
95
96     /* (non-Javadoc)
97      * @see org.mr.core.util.byteable.Byteable#createInstance(org.mr.core.util.byteable.ByteableInputStream)
98      */
99     public Byteable createInstance(ByteableInputStream in) throws IOException JavaDoc {
100         
101         return new ByteableText(in.readUTF());
102     }
103
104     /* (non-Javadoc)
105      * @see org.mr.core.util.byteable.Byteable#registerToByteableRegistry()
106      */
107     public void registerToByteableRegistry() {
108         ByteableRegistry.registerByteableFactory(getByteableName() , this);
109     }
110     
111     public static void register(){
112         ByteableText instance = new ByteableText("");
113         instance.registerToByteableRegistry();
114     }
115     
116     public String JavaDoc toString(){
117         return underLine;
118     }
119
120 }
121
Popular Tags