KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > xml > utils > XMLStringFactory


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 /*
17  * $Id: XMLStringFactory.java,v 1.4 2004/02/17 04:21:14 minchau Exp $
18  */
19 package org.apache.xml.utils;
20
21 /**
22  * A concrete class that implements this interface creates XMLString objects.
23  */
24 public abstract class XMLStringFactory
25 {
26
27   /**
28    * Create a new XMLString from a Java string.
29    *
30    *
31    * @param string Java String reference, which must be non-null.
32    *
33    * @return An XMLString object that wraps the String reference.
34    */
35   public abstract XMLString newstr(String JavaDoc string);
36
37   /**
38    * Create a XMLString from a FastStringBuffer.
39    *
40    *
41    * @param string FastStringBuffer reference, which must be non-null.
42    * @param start The start position in the array.
43    * @param length The number of characters to read from the array.
44    *
45    * @return An XMLString object that wraps the FastStringBuffer reference.
46    */
47   public abstract XMLString newstr(FastStringBuffer string, int start,
48                                    int length);
49
50   /**
51    * Create a XMLString from a FastStringBuffer.
52    *
53    *
54    * @param string FastStringBuffer reference, which must be non-null.
55    * @param start The start position in the array.
56    * @param length The number of characters to read from the array.
57    *
58    * @return An XMLString object that wraps the FastStringBuffer reference.
59    */
60   public abstract XMLString newstr(char[] string, int start,
61                                    int length);
62                                    
63   /**
64    * Get a cheap representation of an empty string.
65    *
66    * @return An non-null reference to an XMLString that represents "".
67    */
68   public abstract XMLString emptystr();
69 }
70
Popular Tags