blob: 0b46b4e18d1e642d9b908a31940fc3b7f3a6d13f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:35 PDT 2012 -->
<TITLE>
Encodings
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.serializer.Encodings class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Encodings";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Encodings.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/serializer/EncodingInfo.InEncoding.html" title="interface in org.apache.xml.serializer"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/serializer/Encodings.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Encodings.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xml.serializer</FONT>
<BR>
Class Encodings</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.serializer.Encodings</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.46"><B>Encodings</B></A><DT>extends java.lang.Object</DL>
</PRE>
<P>
Provides information about encodings. Depends on the Java runtime
to provides writers for the different encodings.
<p>
This class is not a public API. It is only public because it
is used outside of this package.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;<A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#_encodings">_encodings</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.util.Hashtable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#_encodingTableKeyJava">_encodingTableKeyJava</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.util.Hashtable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#_encodingTableKeyMime">_encodingTableKeyMime</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#DEFAULT_MIME_ENCODING">DEFAULT_MIME_ENCODING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default encoding, ISO style, ISO style.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#ENCODINGS_FILE">ENCODINGS_FILE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Standard filename for properties file with encodings data.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#Encodings()">Encodings</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#convertJava2MimeEncoding(java.lang.String)">convertJava2MimeEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try the best we can to convert a Java encoding to a XML-style encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#convertMime2JavaEncoding(java.lang.String)">convertMime2JavaEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try the best we can to convert a Java encoding to a XML-style encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;<A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#getEncodingInfo(java.lang.String)">getEncodingInfo</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the EncodingInfo object for the specified
encoding, never null, although the encoding name
inside the returned EncodingInfo object will be if
we can't find a "real" EncodingInfo for the encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;char</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#getHighChar(java.lang.String)">getHighChar</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Characters with values at or below the high code point are
in the encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#getMimeEncoding(java.lang.String)">getMimeEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the proper mime encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;java.io.Writer</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#getWriter(java.io.OutputStream, java.lang.String)">getWriter</A></B>(java.io.OutputStream&nbsp;output,
java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a writer for the specified encoding based on
an output stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#isHighUTF16Surrogate(char)">isHighUTF16Surrogate</A></B>(char&nbsp;ch)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the character is the high member of a surrogate pair.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#isLowUTF16Surrogate(char)">isLowUTF16Surrogate</A></B>(char&nbsp;ch)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the character is the low member of a surrogate pair.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#isRecognizedEncoding(java.lang.String)">isRecognizedEncoding</A></B>(java.lang.String&nbsp;encoding)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the encoding specified was recognized by the
serializer or not.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#lengthOfMimeNames(java.lang.String)">lengthOfMimeNames</A></B>(java.lang.String&nbsp;val)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the length of the Mime names within the property value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;<A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#loadEncodingInfo()">loadEncodingInfo</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Load a list of all the supported encodings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#toCodePoint(char)">toCodePoint</A></B>(char&nbsp;ch)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the unicode code point represented by the char.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#toCodePoint(char, char)">toCodePoint</A></B>(char&nbsp;highSurrogate,
char&nbsp;lowSurrogate)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the unicode code point represented by the high/low surrogate pair.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Encodings.html#toUpperCaseFast(java.lang.String)">toUpperCaseFast</A></B>(java.lang.String&nbsp;s)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A fast and cheap way to uppercase a String that is
only made of printable ASCII characters.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ENCODINGS_FILE"><!-- --></A><H3>
ENCODINGS_FILE</H3>
<PRE>
private static final java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.51"><B>ENCODINGS_FILE</B></A></PRE>
<DL>
<DD>Standard filename for properties file with encodings data.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="DEFAULT_MIME_ENCODING"><!-- --></A><H3>
DEFAULT_MIME_ENCODING</H3>
<PRE>
static final java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.188"><B>DEFAULT_MIME_ENCODING</B></A></PRE>
<DL>
<DD>The default encoding, ISO style, ISO style.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.serializer.Encodings.DEFAULT_MIME_ENCODING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="_encodingTableKeyJava"><!-- --></A><H3>
_encodingTableKeyJava</H3>
<PRE>
private static final java.util.Hashtable <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.492"><B>_encodingTableKeyJava</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="_encodingTableKeyMime"><!-- --></A><H3>
_encodingTableKeyMime</H3>
<PRE>
private static final java.util.Hashtable <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.493"><B>_encodingTableKeyMime</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="_encodings"><!-- --></A><H3>
_encodings</H3>
<PRE>
private static final <A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A>[] <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.494"><B>_encodings</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Encodings()"><!-- --></A><H3>
Encodings</H3>
<PRE>
public <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.46"><B>Encodings</B></A>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getWriter(java.io.OutputStream, java.lang.String)"><!-- --></A><H3>
getWriter</H3>
<PRE>
static java.io.Writer <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.65"><B>getWriter</B></A>(java.io.OutputStream&nbsp;output,
java.lang.String&nbsp;encoding)
throws java.io.UnsupportedEncodingException</PRE>
<DL>
<DD>Returns a writer for the specified encoding based on
an output stream.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>output</CODE> - The output stream<DD><CODE>encoding</CODE> - The encoding MIME name, not a Java name for the encoding.
<DT><B>Returns:</B><DD>A suitable writer
<DT><B>Throws:</B>
<DD><CODE>java.io.UnsupportedEncodingException</CODE> - There is no convertor
to support this encoding</DL>
</DD>
</DL>
<HR>
<A NAME="getEncodingInfo(java.lang.String)"><!-- --></A><H3>
getEncodingInfo</H3>
<PRE>
static <A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A> <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.114"><B>getEncodingInfo</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Returns the EncodingInfo object for the specified
encoding, never null, although the encoding name
inside the returned EncodingInfo object will be if
we can't find a "real" EncodingInfo for the encoding.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The encoding
<DT><B>Returns:</B><DD>The object that is used to determine if
characters are in the given encoding.</DL>
</DD>
</DL>
<HR>
<A NAME="isRecognizedEncoding(java.lang.String)"><!-- --></A><H3>
isRecognizedEncoding</H3>
<PRE>
public static boolean <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.137"><B>isRecognizedEncoding</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Determines if the encoding specified was recognized by the
serializer or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The encoding
<DT><B>Returns:</B><DD>boolean - true if the encoding was recognized else false</DL>
</DD>
</DL>
<HR>
<A NAME="toUpperCaseFast(java.lang.String)"><!-- --></A><H3>
toUpperCaseFast</H3>
<PRE>
private static java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.160"><B>toUpperCaseFast</B></A>(java.lang.String&nbsp;s)</PRE>
<DL>
<DD>A fast and cheap way to uppercase a String that is
only made of printable ASCII characters.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - a String of ASCII characters
<DT><B>Returns:</B><DD>an uppercased version of the input String,
possibly the same String.</DL>
</DD>
</DL>
<HR>
<A NAME="getMimeEncoding(java.lang.String)"><!-- --></A><H3>
getMimeEncoding</H3>
<PRE>
static java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.209"><B>getMimeEncoding</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Get the proper mime encoding. From the XSLT recommendation: "The encoding
attribute specifies the preferred encoding to use for outputting the result
tree. XSLT processors are required to respect values of UTF-8 and UTF-16.
For other values, if the XSLT processor does not support the specified
encoding it may signal an error; if it does not signal an error it should
use UTF-8 or UTF-16 instead. The XSLT processor must not use an encoding
whose name does not match the EncName production of the XML Recommendation
[XML]. If no encoding attribute is specified, then the XSLT processor should
use either UTF-8 or UTF-16."
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - Reference to java-style encoding string, which may be null,
in which case a default will be found.
<DT><B>Returns:</B><DD>The ISO-style encoding string, or null if failure.</DL>
</DD>
</DL>
<HR>
<A NAME="convertJava2MimeEncoding(java.lang.String)"><!-- --></A><H3>
convertJava2MimeEncoding</H3>
<PRE>
private static java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.270"><B>convertJava2MimeEncoding</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Try the best we can to convert a Java encoding to a XML-style encoding.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - non-null reference to encoding string, java style.
<DT><B>Returns:</B><DD>ISO-style encoding string.</DL>
</DD>
</DL>
<HR>
<A NAME="convertMime2JavaEncoding(java.lang.String)"><!-- --></A><H3>
convertMime2JavaEncoding</H3>
<PRE>
public static java.lang.String <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.291"><B>convertMime2JavaEncoding</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Try the best we can to convert a Java encoding to a XML-style encoding.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - non-null reference to encoding string, java style.
<DT><B>Returns:</B><DD>ISO-style encoding string.
<p>
This method is not a public API.</DL>
</DD>
</DL>
<HR>
<A NAME="loadEncodingInfo()"><!-- --></A><H3>
loadEncodingInfo</H3>
<PRE>
private static <A HREF="../../../../org/apache/xml/serializer/EncodingInfo.html" title="class in org.apache.xml.serializer">EncodingInfo</A>[] <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.313"><B>loadEncodingInfo</B></A>()</PRE>
<DL>
<DD>Load a list of all the supported encodings.
System property "encodings" formatted using URL syntax may define an
external encodings list. Thanks to Sergey Ushakov for the code
contribution!
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="lengthOfMimeNames(java.lang.String)"><!-- --></A><H3>
lengthOfMimeNames</H3>
<PRE>
private static int <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.401"><B>lengthOfMimeNames</B></A>(java.lang.String&nbsp;val)</PRE>
<DL>
<DD>Get the length of the Mime names within the property value
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>val</CODE> - The value of the property, which should contain a comma
separated list of Mime names, followed optionally by a space and the
high char value
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="isHighUTF16Surrogate(char)"><!-- --></A><H3>
isHighUTF16Surrogate</H3>
<PRE>
static boolean <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.419"><B>isHighUTF16Surrogate</B></A>(char&nbsp;ch)</PRE>
<DL>
<DD>Return true if the character is the high member of a surrogate pair.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to test</DL>
</DD>
</DL>
<HR>
<A NAME="isLowUTF16Surrogate(char)"><!-- --></A><H3>
isLowUTF16Surrogate</H3>
<PRE>
static boolean <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.429"><B>isLowUTF16Surrogate</B></A>(char&nbsp;ch)</PRE>
<DL>
<DD>Return true if the character is the low member of a surrogate pair.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to test</DL>
</DD>
</DL>
<HR>
<A NAME="toCodePoint(char, char)"><!-- --></A><H3>
toCodePoint</H3>
<PRE>
static int <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.440"><B>toCodePoint</B></A>(char&nbsp;highSurrogate,
char&nbsp;lowSurrogate)</PRE>
<DL>
<DD>Return the unicode code point represented by the high/low surrogate pair.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>highSurrogate</CODE> - the high char of the high/low pair<DD><CODE>lowSurrogate</CODE> - the low char of the high/low pair</DL>
</DD>
</DL>
<HR>
<A NAME="toCodePoint(char)"><!-- --></A><H3>
toCodePoint</H3>
<PRE>
static int <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.456"><B>toCodePoint</B></A>(char&nbsp;ch)</PRE>
<DL>
<DD>Return the unicode code point represented by the char.
A bit of a dummy method, since all it does is return the char,
but as an int value.
<p>
This is not a public API.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ch</CODE> - the char.</DL>
</DD>
</DL>
<HR>
<A NAME="getHighChar(java.lang.String)"><!-- --></A><H3>
getHighChar</H3>
<PRE>
public static char <A HREF="../../../../src-html/org/apache/xml/serializer/Encodings.html#line.476"><B>getHighChar</B></A>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Characters with values at or below the high code point are
in the encoding. Code point values above this one may or may
not be in the encoding, but lower ones certainly are.
<p>
This is for performance.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The encoding
<DT><B>Returns:</B><DD>The code point for which characters at or below this code point
are in the encoding. Characters with higher code point may or may not be
in the encoding. A value of zero is returned if the high code point is unknown.
<p>
This method is not a public API.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Encodings.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/serializer/EncodingInfo.InEncoding.html" title="interface in org.apache.xml.serializer"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/serializer/ExtendedContentHandler.html" title="interface in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/serializer/Encodings.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Encodings.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>