1. /*
  2. * The Apache Software License, Version 1.1
  3. *
  4. *
  5. * Copyright (c) 1999 The Apache Software Foundation. All rights
  6. * reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in
  17. * the documentation and/or other materials provided with the
  18. * distribution.
  19. *
  20. * 3. The end-user documentation included with the redistribution,
  21. * if any, must include the following acknowledgment:
  22. * "This product includes software developed by the
  23. * Apache Software Foundation (http://www.apache.org/)."
  24. * Alternately, this acknowledgment may appear in the software itself,
  25. * if and wherever such third-party acknowledgments normally appear.
  26. *
  27. * 4. The names "Xalan" and "Apache Software Foundation" must
  28. * not be used to endorse or promote products derived from this
  29. * software without prior written permission. For written
  30. * permission, please contact apache@apache.org.
  31. *
  32. * 5. Products derived from this software may not be called "Apache",
  33. * nor may "Apache" appear in their name, without prior written
  34. * permission of the Apache Software Foundation.
  35. *
  36. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  37. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  38. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  39. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  40. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  43. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  44. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  45. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  46. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47. * SUCH DAMAGE.
  48. * ====================================================================
  49. *
  50. * This software consists of voluntary contributions made by many
  51. * individuals on behalf of the Apache Software Foundation and was
  52. * originally based on software copyright (c) 1999, Lotus
  53. * Development Corporation., http://www.lotus.com. For more
  54. * information on the Apache Software Foundation, please see
  55. * <http://www.apache.org/>.
  56. */
  57. package org.apache.xml.utils;
  58. /**
  59. * A concrete class that implements this interface creates XMLString objects.
  60. */
  61. public abstract class XMLStringFactory
  62. {
  63. /**
  64. * Create a new XMLString from a Java string.
  65. *
  66. *
  67. * @param string Java String reference, which must be non-null.
  68. *
  69. * @return An XMLString object that wraps the String reference.
  70. */
  71. public abstract XMLString newstr(String string);
  72. /**
  73. * Create a XMLString from a FastStringBuffer.
  74. *
  75. *
  76. * @param string FastStringBuffer reference, which must be non-null.
  77. * @param start The start position in the array.
  78. * @param length The number of characters to read from the array.
  79. *
  80. * @return An XMLString object that wraps the FastStringBuffer reference.
  81. */
  82. public abstract XMLString newstr(FastStringBuffer string, int start,
  83. int length);
  84. /**
  85. * Create a XMLString from a FastStringBuffer.
  86. *
  87. *
  88. * @param string FastStringBuffer reference, which must be non-null.
  89. * @param start The start position in the array.
  90. * @param length The number of characters to read from the array.
  91. *
  92. * @return An XMLString object that wraps the FastStringBuffer reference.
  93. */
  94. public abstract XMLString newstr(char[] string, int start,
  95. int length);
  96. /**
  97. * Get a cheap representation of an empty string.
  98. *
  99. * @return An non-null reference to an XMLString that represents "".
  100. */
  101. public abstract XMLString emptystr();
  102. }