blob: 3a62bd4d27b861355458945b5da3d92bb35abaa8 [file] [log] [blame]
<HTML><HEAD><META CONTENT="text/html; charset=UTF-8" HTTP-EQUIV="Content-Type"/><TITLE>EMMA Coverage Report</TITLE><STYLE TYPE="text/css"> TABLE,TD,TH {border-style:solid; border-color:black;} TD,TH {background:white;margin:0;line-height:100%;padding-left:0.5em;padding-right:0.5em;} TD {border-width:0 1px 0 0;} TH {border-width:1px 1px 1px 0;} TR TD.h {color:red;} TABLE {border-spacing:0; border-collapse:collapse;border-width:0 0 1px 1px;} P,H1,H2,H3,TH {font-family:verdana,arial,sans-serif;font-size:10pt;} TD {font-family:courier,monospace;font-size:10pt;} TABLE.hdft {border-spacing:0;border-collapse:collapse;border-style:none;} TABLE.hdft TH,TABLE.hdft TD {border-style:none;line-height:normal;} TABLE.hdft TH.tl,TABLE.hdft TD.tl {background:#6699CC;color:white;} TABLE.hdft TD.nv {background:#6633DD;color:white;} .nv A:link {color:white;} .nv A:visited {color:white;} .nv A:active {color:yellow;} TABLE.hdft A:link {color:white;} TABLE.hdft A:visited {color:white;} TABLE.hdft A:active {color:yellow;} .in {color:#356085;} TABLE.s TD {padding-left:0.25em;padding-right:0.25em;} TABLE.s TD.l {padding-left:0.25em;padding-right:0.25em;text-align:right;background:#F0F0F0;} TABLE.s TR.z TD {background:#FF9999;} TABLE.s TR.p TD {background:#FFFF88;} TABLE.s TR.c TD {background:#CCFFCC;} A:link {color:#0000EE;text-decoration:none;} A:visited {color:#0000EE;text-decoration:none;} A:hover {color:#0000EE;text-decoration:underline;} TABLE.cn {border-width:0 0 1px 0;} TABLE.s {border-width:1px 0 1px 1px;} TD.h {color:red;border-width:0 1px 0 0;} TD.f {border-width:0 1px 0 1px;} TD.hf {color:red;border-width:0 1px 0 1px;} TH.f {border-width:1px 1px 1px 1px;} TR.cis TD {background:#F0F0F0;} TR.cis TD {border-width:1px 1px 1px 0;} TR.cis TD.h {color:red;border-width:1px 1px 1px 0;} TR.cis TD.f {border-width:1px 1px 1px 1px;} TR.cis TD.hf {color:red;border-width:1px 1px 1px 1px;} TD.b {border-style:none;background:transparent;line-height:50%;} TD.bt {border-width:1px 0 0 0;background:transparent;line-height:50%;} TR.o TD {background:#F0F0F0;}TABLE.it {border-style:none;}TABLE.it TD,TABLE.it TH {border-style:none;}</STYLE></HEAD><BODY><TABLE CLASS="hdft" CELLSPACING="0" WIDTH="100%"><TR><TH CLASS="tl"><A HREF="http://www.eclemma.org/">EMMA</A> Coverage Report (generated Fri Feb 20 18:44:54 GMT 2009)</TH></TR><TR><TD CLASS="nv">[<A HREF="../xslUnitTestCoverage.html">all classes</A>][<A HREF="73.html">org.eclipse.wst.sse.core.internal.encoding</A>]</TD></TR></TABLE><H2>COVERAGE SUMMARY FOR SOURCE FILE [<SPAN CLASS="in">EncodingMemento.java</SPAN>]</H2><TABLE CELLSPACING="0" WIDTH="100%"><TR><TH>name</TH><TH>class, %</TH><TH>method, %</TH><TH>block, %</TH><TH>line, %</TH></TR><TR><TD>EncodingMemento.java</TD><TD>100% (1/1)</TD><TD CLASS="h">24%  (4/17)</TD><TD CLASS="h">17%  (15/90)</TD><TD CLASS="h">23%  (8/35)</TD></TR></TABLE><H3>COVERAGE BREAKDOWN BY CLASS AND METHOD</H3><TABLE CLASS="cn" CELLSPACING="0" WIDTH="100%"><TR><TH CLASS="f">name</TH><TH>class, %</TH><TH>method, %</TH><TH>block, %</TH><TH>line, %</TH></TR><TR><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD></TR><TR CLASS="cis"><TD CLASS="f">class <A HREF="#0">EncodingMemento</A></TD><TD>100% (1/1)</TD><TD CLASS="h">24%  (4/17)</TD><TD CLASS="h">17%  (15/90)</TD><TD CLASS="h">23%  (8/35)</TD></TR><TR><TD CLASS="f"><A HREF="#1">clone (): Object</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/10)</TD><TD CLASS="h">0%   (0/4)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#2">getAppropriateDefault (): String</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/10)</TD><TD CLASS="h">0%   (0/3)</TD></TR><TR><TD CLASS="f"><A HREF="#3">getDetectedCharsetName (): String</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/3)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#4">getInvalidEncoding (): String</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/3)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR><TD CLASS="f"><A HREF="#5">getJavaCharsetName (): String</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/3)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#6">getUnicodeBOM (): byte []</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/17)</TD><TD CLASS="h">0%   (0/6)</TD></TR><TR><TD CLASS="f"><A HREF="#7">isUTF83ByteBOMUsed (): boolean</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/3)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#8">isUnicodeStream (): boolean</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/3)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR><TD CLASS="f"><A HREF="#9">isValid (): boolean</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/7)</TD><TD CLASS="h">0%   (0/1)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#a">setInvalidEncoding (String): void</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/4)</TD><TD CLASS="h">0%   (0/2)</TD></TR><TR><TD CLASS="f"><A HREF="#b">setUTF83ByteBOMUsed (boolean): void</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/4)</TD><TD CLASS="h">0%   (0/2)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#c">setUnicodeBOM (byte []): void</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/4)</TD><TD CLASS="h">0%   (0/2)</TD></TR><TR><TD CLASS="f"><A HREF="#d">setUnicodeStream (boolean): void</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/4)</TD><TD CLASS="h">0%   (0/2)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#0">EncodingMemento (): void</A></TD><TD> </TD><TD>100% (1/1)</TD><TD>100% (3/3)</TD><TD>100% (2/2)</TD></TR><TR><TD CLASS="f"><A HREF="#f">setAppropriateDefault (String): void</A></TD><TD> </TD><TD>100% (1/1)</TD><TD>100% (4/4)</TD><TD>100% (2/2)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#10">setDetectedCharsetName (String): void</A></TD><TD> </TD><TD>100% (1/1)</TD><TD>100% (4/4)</TD><TD>100% (2/2)</TD></TR><TR><TD CLASS="f"><A HREF="#11">setJavaCharsetName (String): void</A></TD><TD> </TD><TD>100% (1/1)</TD><TD>100% (4/4)</TD><TD>100% (2/2)</TD></TR></TABLE><P></P><TABLE CLASS="s" CELLSPACING="0" WIDTH="100%"><TR><TD CLASS="l">1</TD><TD>/*******************************************************************************</TD></TR><TR><TD CLASS="l">2</TD><TD> * Copyright (c) 2001, 2008 IBM Corporation and others.</TD></TR><TR><TD CLASS="l">3</TD><TD> * All rights reserved. This program and the accompanying materials</TD></TR><TR><TD CLASS="l">4</TD><TD> * are made available under the terms of the Eclipse Public License v1.0</TD></TR><TR><TD CLASS="l">5</TD><TD> * which accompanies this distribution, and is available at</TD></TR><TR><TD CLASS="l">6</TD><TD> * http://www.eclipse.org/legal/epl-v10.html</TD></TR><TR><TD CLASS="l">7</TD><TD> *</TD></TR><TR><TD CLASS="l">8</TD><TD> * Contributors:</TD></TR><TR><TD CLASS="l">9</TD><TD> *     IBM Corporation - initial API and implementation</TD></TR><TR><TD CLASS="l">10</TD><TD> *     Jens Lukowski/Innoopract - initial renaming/restructuring</TD></TR><TR><TD CLASS="l">11</TD><TD> *     </TD></TR><TR><TD CLASS="l">12</TD><TD> *******************************************************************************/</TD></TR><TR><TD CLASS="l">13</TD><TD>package org.eclipse.wst.sse.core.internal.encoding;</TD></TR><TR><TD CLASS="l">14</TD><TD> </TD></TR><TR><TD CLASS="l">15</TD><TD>import org.eclipse.core.runtime.content.IContentDescription;</TD></TR><TR><TD CLASS="l">16</TD><TD> </TD></TR><TR><TD CLASS="l">17</TD><TD> </TD></TR><TR><TD CLASS="l">18</TD><TD>/**</TD></TR><TR><TD CLASS="l">19</TD><TD> * This class is to simply hold information and data about the type of</TD></TR><TR><TD CLASS="l">20</TD><TD> * encoding found for a resource. It not only includes names, etc., but also</TD></TR><TR><TD CLASS="l">21</TD><TD> * gives hints about the algorithm, or rule, that the encodng was determined.</TD></TR><TR><TD CLASS="l">22</TD><TD> * Having all this info in a central object, associated with the Document</TD></TR><TR><TD CLASS="l">23</TD><TD> * (technically, IStructuredDocument), allows for better user error messages,</TD></TR><TR><TD CLASS="l">24</TD><TD> * and better handling of knowing how to dump a file, given we know how it was</TD></TR><TR><TD CLASS="l">25</TD><TD> * loaded.</TD></TR><TR><TD CLASS="l">26</TD><TD> * </TD></TR><TR><TD CLASS="l">27</TD><TD> * Note: the data in this class is only valid if its has actually gone through</TD></TR><TR><TD CLASS="l">28</TD><TD> * the loading or dumping sequence. It is not accurate, for example, if a</TD></TR><TR><TD CLASS="l">29</TD><TD> * structuredDocument is simply created and then setText called. In this type</TD></TR><TR><TD CLASS="l">30</TD><TD> * of case, accuracy for loading and dumping is not required, since its all</TD></TR><TR><TD CLASS="l">31</TD><TD> * re-discovered. One limitation is that structuredDocument's created &#34;from</TD></TR><TR><TD CLASS="l">32</TD><TD> * scratch&#34; this way, don't have any encoding information to count on, and</TD></TR><TR><TD CLASS="l">33</TD><TD> * would have to arrange the processing to be done. (And it is done,</TD></TR><TR><TD CLASS="l">34</TD><TD> * automatically if going through loader or dumper, but perhaps not in future</TD></TR><TR><TD CLASS="l">35</TD><TD> * new uses. TODO: this can be inproved in future versions.)</TD></TR><TR><TD CLASS="l">36</TD><TD> * </TD></TR><TR><TD CLASS="l">37</TD><TD> * isInitialized is set when the loader or dumper processes have been used,</TD></TR><TR><TD CLASS="l">38</TD><TD> * but even this can't be counted on 100% if the document has been modified</TD></TR><TR><TD CLASS="l">39</TD><TD> * since.</TD></TR><TR><TD CLASS="l">40</TD><TD> * </TD></TR><TR><TD CLASS="l">41</TD><TD> */</TD></TR><TR><TD CLASS="l">42</TD><TD>public class EncodingMemento implements Cloneable {</TD></TR><TR><TD CLASS="l">43</TD><TD> </TD></TR><TR><TD CLASS="l">44</TD><TD>        public final static String CLONED = &#34;cloned&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">45</TD><TD>        public final static String DEFAULTS_ASSUMED_FOR_EMPTY_INPUT = &#34;DefaultsAssumedForEmptyInput&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">46</TD><TD>        public final static String DEFAULTS_USED_DUE_TO_SMALL_STREAM = &#34;defaultsUsedDueToSmallStream&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">47</TD><TD> </TD></TR><TR><TD CLASS="l">48</TD><TD> </TD></TR><TR><TD CLASS="l">49</TD><TD>        /*</TD></TR><TR><TD CLASS="l">50</TD><TD>         * Strings to be used for tracing. TODO: need to clean this up, we no</TD></TR><TR><TD CLASS="l">51</TD><TD>         * longer use all of them</TD></TR><TR><TD CLASS="l">52</TD><TD>         */</TD></TR><TR><TD CLASS="l">53</TD><TD>        public final static String DETECTED_STANDARD_UNICODE_BYTES = &#34;detectedStandardUnicodeBytes&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">54</TD><TD>        public final static String FOUND_ENCODING_IN_CONTENT = &#34;foundEncodingInContent&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">55</TD><TD>        public final static String FOUND_ENCODING_IN_STREAM = &#34;foundEncodingInStream&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">56</TD><TD>        public final static String FOUND_ENCODING_IN_STRUCTURED_DOCUMENT = &#34;foundEncodingInStructuredDocument&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">57</TD><TD>        public final static String GUESSED_ENCODING_FROM_STREAM = &#34;GuessEncodingFromStream&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">58</TD><TD>        public final static String JAVA_NAME_FOUND_AS_IANA_NAME = &#34;noMappingFoundButJavaNameFoundToBeIANAName&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">59</TD><TD>        public final static String JAVA_NAME_FOUND_IN_ALIAS_NAME = &#34;noMappingFoundButJavaNameFoundInAliasTable&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">60</TD><TD>        public final static String NO_IANA_NAME_FOUND = &#34;noMappingFoundFromJavaNameToIANAName&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">61</TD><TD>        public final static String USED_CONTENT_TYPE_DEFAULT = &#34;UsedContentTypeDefault&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">62</TD><TD>        public final static String USED_JAVA_DEFAULT = &#34;UsedJavaDefault&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">63</TD><TD>        public final static String USED_MEMENTO_FROM_LOAD = &#34;usedMementoFromLoad&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">64</TD><TD>        public final static String USED_PROPERTY_SETTINGS = &#34;USED_PROPERTY_SETTINGS&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">65</TD><TD>        public final static String USED_USER_SPECIFIED_PREFERENCE = &#34;UsedUserSpecifiedPreference&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">66</TD><TD>        public final static String USED_WORKSPACE_DEFAULT = &#34;UsedWorkspaceDefault&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">67</TD><TD>        public final static String USER_IS_USING_JAVA_ENCODING = &#34;UserIsUsingJavaEncoding&#34;; //$NON-NLS-1$</TD></TR><TR><TD CLASS="l">68</TD><TD>        private String fAppropriateDefault;</TD></TR><TR><TD CLASS="l">69</TD><TD>        private String fDetectedCharsetName;</TD></TR><TR><TD CLASS="l">70</TD><TD>        private String fInvalidEncoding;</TD></TR><TR><TD CLASS="l">71</TD><TD> </TD></TR><TR><TD CLASS="l">72</TD><TD> </TD></TR><TR><TD CLASS="l">73</TD><TD>        private String fJavaCharsetName;</TD></TR><TR><TD CLASS="l">74</TD><TD>        private boolean fUnicodeStream;</TD></TR><TR><TD CLASS="l">75</TD><TD>        private boolean fUTF83ByteBOMUsed;</TD></TR><TR><TD CLASS="l"><A NAME="0">76</A></TD><TD>        </TD></TR><TR><TD CLASS="l">77</TD><TD>        private byte[] fBOM;</TD></TR><TR><TD CLASS="l">78</TD><TD> </TD></TR><TR><TD CLASS="l">79</TD><TD>        public EncodingMemento() {</TD></TR><TR CLASS="c"><TD CLASS="l">80</TD><TD>                super();</TD></TR><TR CLASS="c"><TD CLASS="l">81</TD><TD>        }</TD></TR><TR><TD CLASS="l">82</TD><TD> </TD></TR><TR><TD CLASS="l"><A NAME="1">83</A></TD><TD>        /**</TD></TR><TR><TD CLASS="l">84</TD><TD>         * Returns a clone of this object.</TD></TR><TR><TD CLASS="l">85</TD><TD>         */</TD></TR><TR><TD CLASS="l">86</TD><TD>        public Object clone() {</TD></TR><TR CLASS="z"><TD CLASS="l">87</TD><TD>                EncodingMemento object = null;</TD></TR><TR><TD CLASS="l">88</TD><TD>                try {</TD></TR><TR CLASS="z"><TD CLASS="l">89</TD><TD>                        object = (EncodingMemento) super.clone();</TD></TR><TR><TD CLASS="l">90</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">91</TD><TD>                catch (CloneNotSupportedException e) {</TD></TR><TR><TD CLASS="l">92</TD><TD>                        // impossible, since we're implementing here</TD></TR><TR><TD CLASS="l">93</TD><TD>                }</TD></TR><TR><TD CLASS="l">94</TD><TD> </TD></TR><TR CLASS="z"><TD CLASS="l">95</TD><TD>                return object;</TD></TR><TR><TD CLASS="l">96</TD><TD> </TD></TR><TR><TD CLASS="l">97</TD><TD>        }</TD></TR><TR><TD CLASS="l">98</TD><TD> </TD></TR><TR><TD CLASS="l">99</TD><TD>        /**</TD></TR><TR><TD CLASS="l">100</TD><TD>         * Returns the appropriateDefault. This is only set if an invalid encoding</TD></TR><TR><TD CLASS="l">101</TD><TD>         * was found, and contains an charset appropriate to use as a default</TD></TR><TR><TD CLASS="l">102</TD><TD>         * value, if, for example, the user decides to load the document anyway,</TD></TR><TR><TD CLASS="l">103</TD><TD>         * even though the charset was found to be invalid.</TD></TR><TR><TD CLASS="l"><A NAME="2">104</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">105</TD><TD>         * @return String</TD></TR><TR><TD CLASS="l">106</TD><TD>         */</TD></TR><TR><TD CLASS="l">107</TD><TD>        public String getAppropriateDefault() {</TD></TR><TR CLASS="z"><TD CLASS="l">108</TD><TD>                if (fAppropriateDefault == null) {</TD></TR><TR CLASS="z"><TD CLASS="l">109</TD><TD>                        fAppropriateDefault = NonContentBasedEncodingRules.useDefaultNameRules(null);</TD></TR><TR><TD CLASS="l">110</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">111</TD><TD>                return fAppropriateDefault;</TD></TR><TR><TD CLASS="l">112</TD><TD>        }</TD></TR><TR><TD CLASS="l">113</TD><TD> </TD></TR><TR><TD CLASS="l">114</TD><TD>        /**</TD></TR><TR><TD CLASS="l">115</TD><TD>         * Returns the charset name, if it is different from the charset name</TD></TR><TR><TD CLASS="l">116</TD><TD>         * found in getJavaCharsetName. This can happen, for example, if there are</TD></TR><TR><TD CLASS="l">117</TD><TD>         * differences in case. This method might return SHIFT_JIS, and the the</TD></TR><TR><TD CLASS="l">118</TD><TD>         * getJavaCharsetName might return Shift_JIS -- if SHIFT_JIS was detected</TD></TR><TR><TD CLASS="l">119</TD><TD>         * in file/document. If the original file contained the correct case, then</TD></TR><TR><TD CLASS="l">120</TD><TD>         * this method would return null. The getJavaCharsetName is typically the</TD></TR><TR><TD CLASS="l">121</TD><TD>         * one that should always be used, and this one only used for certain</TD></TR><TR><TD CLASS="l">122</TD><TD>         * error conditions, or or if when creating a &#34;duplicate&#34; resource, it was</TD></TR><TR><TD CLASS="l">123</TD><TD>         * desired to use exactly the charset name as in the original document. As</TD></TR><TR><TD CLASS="l">124</TD><TD>         * an example of this later case, the original document might contain</TD></TR><TR><TD CLASS="l">125</TD><TD>         * ISO-8859-9, but the detected charset name might contain ISO-8859-9-I.</TD></TR><TR><TD CLASS="l"><A NAME="3">126</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">127</TD><TD>         * @return String</TD></TR><TR><TD CLASS="l">128</TD><TD>         */</TD></TR><TR><TD CLASS="l">129</TD><TD>        public String getDetectedCharsetName() {</TD></TR><TR CLASS="z"><TD CLASS="l">130</TD><TD>                return fDetectedCharsetName;</TD></TR><TR><TD CLASS="l">131</TD><TD>        }</TD></TR><TR><TD CLASS="l">132</TD><TD> </TD></TR><TR><TD CLASS="l">133</TD><TD>        /**</TD></TR><TR><TD CLASS="l">134</TD><TD>         * Returns a charset name that was detected, but not found to be a charset</TD></TR><TR><TD CLASS="l">135</TD><TD>         * suppoorted by the VM.</TD></TR><TR><TD CLASS="l"><A NAME="4">136</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">137</TD><TD>         * @return String</TD></TR><TR><TD CLASS="l">138</TD><TD>         */</TD></TR><TR><TD CLASS="l">139</TD><TD>        public String getInvalidEncoding() {</TD></TR><TR CLASS="z"><TD CLASS="l">140</TD><TD>                return fInvalidEncoding;</TD></TR><TR><TD CLASS="l">141</TD><TD>        }</TD></TR><TR><TD CLASS="l">142</TD><TD> </TD></TR><TR><TD CLASS="l">143</TD><TD>        /**</TD></TR><TR><TD CLASS="l">144</TD><TD>         * Returns the java cononical charset name.</TD></TR><TR><TD CLASS="l"><A NAME="5">145</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">146</TD><TD>         * @return String</TD></TR><TR><TD CLASS="l">147</TD><TD>         */</TD></TR><TR><TD CLASS="l">148</TD><TD>        public String getJavaCharsetName() {</TD></TR><TR CLASS="z"><TD CLASS="l">149</TD><TD>                return fJavaCharsetName;</TD></TR><TR><TD CLASS="l">150</TD><TD>        }</TD></TR><TR><TD CLASS="l">151</TD><TD> </TD></TR><TR><TD CLASS="l">152</TD><TD>        /**</TD></TR><TR><TD CLASS="l">153</TD><TD>         * Note: we may be able to remove this method, if it turns out this work</TD></TR><TR><TD CLASS="l">154</TD><TD>         * is done by &#34;text&#34; type.</TD></TR><TR><TD CLASS="l"><A NAME="6">155</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">156</TD><TD>         * @deprecated -</TD></TR><TR><TD CLASS="l">157</TD><TD>         */</TD></TR><TR><TD CLASS="l">158</TD><TD>        public byte[] getUnicodeBOM() {</TD></TR><TR CLASS="z"><TD CLASS="l">159</TD><TD>                byte[] bom = null;</TD></TR><TR CLASS="z"><TD CLASS="l">160</TD><TD>                if (isUTF83ByteBOMUsed())</TD></TR><TR CLASS="z"><TD CLASS="l">161</TD><TD>                        bom = IContentDescription.BOM_UTF_8;</TD></TR><TR CLASS="z"><TD CLASS="l">162</TD><TD>                else if (isUnicodeStream())</TD></TR><TR CLASS="z"><TD CLASS="l">163</TD><TD>                        bom = fBOM;</TD></TR><TR CLASS="z"><TD CLASS="l">164</TD><TD>                return bom;</TD></TR><TR><TD CLASS="l">165</TD><TD>        }</TD></TR><TR><TD CLASS="l">166</TD><TD> </TD></TR><TR><TD CLASS="l">167</TD><TD>        /**</TD></TR><TR><TD CLASS="l">168</TD><TD>         * Note: in our implementation, the stream is a unicode stream if the</TD></TR><TR><TD CLASS="l">169</TD><TD>         * charset is UTF-16, UTF-16LE, or UTF-16BE. A stream with 3 byte BOM is</TD></TR><TR><TD CLASS="l">170</TD><TD>         * not considered unicode stream here.</TD></TR><TR><TD CLASS="l"><A NAME="8">171</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">172</TD><TD>         * @return returns true if is a unicode (UTF-16) stream</TD></TR><TR><TD CLASS="l">173</TD><TD>         */</TD></TR><TR><TD CLASS="l">174</TD><TD>        public boolean isUnicodeStream() {</TD></TR><TR CLASS="z"><TD CLASS="l">175</TD><TD>                return fUnicodeStream;</TD></TR><TR><TD CLASS="l">176</TD><TD>        }</TD></TR><TR><TD CLASS="l">177</TD><TD> </TD></TR><TR><TD CLASS="l">178</TD><TD>        /**</TD></TR><TR><TD CLASS="l">179</TD><TD>         * Note: in our implementation, the stream is a unicode stream if the</TD></TR><TR><TD CLASS="l">180</TD><TD>         * charset is UTF-16, UTF-16LE, or UTF-16BE. A stream with 3 byte BOM is</TD></TR><TR><TD CLASS="l">181</TD><TD>         * not considered unicode stream here.</TD></TR><TR><TD CLASS="l">182</TD><TD>         * </TD></TR><TR><TD CLASS="l">183</TD><TD>         * Set during load, can be used by dumper to write 3 byte BOM, which Java</TD></TR><TR><TD CLASS="l">184</TD><TD>         * does not normally do. This helps maintain compatibility with other</TD></TR><TR><TD CLASS="l">185</TD><TD>         * programs (those that wrote the 3 byte BOM there to begin with.</TD></TR><TR><TD CLASS="l"><A NAME="7">186</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">187</TD><TD>         * @return boolean</TD></TR><TR><TD CLASS="l">188</TD><TD>         */</TD></TR><TR><TD CLASS="l">189</TD><TD>        public boolean isUTF83ByteBOMUsed() {</TD></TR><TR CLASS="z"><TD CLASS="l"><A NAME="9">190</A></TD><TD>                return fUTF83ByteBOMUsed;</TD></TR><TR><TD CLASS="l">191</TD><TD>        }</TD></TR><TR><TD CLASS="l">192</TD><TD> </TD></TR><TR><TD CLASS="l">193</TD><TD>        public boolean isValid() {</TD></TR><TR CLASS="z"><TD CLASS="l">194</TD><TD>                return getInvalidEncoding() == null;</TD></TR><TR><TD CLASS="l">195</TD><TD>        }</TD></TR><TR><TD CLASS="l">196</TD><TD> </TD></TR><TR><TD CLASS="l">197</TD><TD>        /**</TD></TR><TR><TD CLASS="l">198</TD><TD>         * Sets the appropriateDefault.</TD></TR><TR><TD CLASS="l">199</TD><TD>         * </TD></TR><TR><TD CLASS="l"><A NAME="f">200</A></TD><TD>         * @param appropriateDefault</TD></TR><TR><TD CLASS="l">201</TD><TD>         *            The appropriateDefault to set</TD></TR><TR><TD CLASS="l">202</TD><TD>         */</TD></TR><TR><TD CLASS="l">203</TD><TD>        public void setAppropriateDefault(String appropriateDefault) {</TD></TR><TR CLASS="c"><TD CLASS="l">204</TD><TD>                fAppropriateDefault = appropriateDefault;</TD></TR><TR CLASS="c"><TD CLASS="l"><A NAME="10">205</A></TD><TD>        }</TD></TR><TR><TD CLASS="l">206</TD><TD> </TD></TR><TR><TD CLASS="l">207</TD><TD> </TD></TR><TR><TD CLASS="l">208</TD><TD>        public void setDetectedCharsetName(String detectedCharsetName) {</TD></TR><TR CLASS="c"><TD CLASS="l"><A NAME="a">209</A></TD><TD>                fDetectedCharsetName = detectedCharsetName;</TD></TR><TR CLASS="c"><TD CLASS="l">210</TD><TD>        }</TD></TR><TR><TD CLASS="l">211</TD><TD> </TD></TR><TR><TD CLASS="l">212</TD><TD>        public void setInvalidEncoding(String invalidEncoding) {</TD></TR><TR CLASS="z"><TD CLASS="l">213</TD><TD>                fInvalidEncoding = invalidEncoding;</TD></TR><TR CLASS="z"><TD CLASS="l">214</TD><TD>        }</TD></TR><TR><TD CLASS="l">215</TD><TD> </TD></TR><TR><TD CLASS="l">216</TD><TD>        /**</TD></TR><TR><TD CLASS="l">217</TD><TD>         * Sets the javaEncodingName.</TD></TR><TR><TD CLASS="l">218</TD><TD>         * </TD></TR><TR><TD CLASS="l"><A NAME="11">219</A></TD><TD>         * @param javaEncodingName</TD></TR><TR><TD CLASS="l">220</TD><TD>         *            The javaEncodingName to set</TD></TR><TR><TD CLASS="l">221</TD><TD>         */</TD></TR><TR><TD CLASS="l">222</TD><TD>        public void setJavaCharsetName(String javaCharsetName) {</TD></TR><TR CLASS="c"><TD CLASS="l">223</TD><TD>                fJavaCharsetName = javaCharsetName;</TD></TR><TR CLASS="c"><TD CLASS="l">224</TD><TD>        }</TD></TR><TR><TD CLASS="l">225</TD><TD> </TD></TR><TR><TD CLASS="l"><A NAME="d">226</A></TD><TD>        /**</TD></TR><TR><TD CLASS="l">227</TD><TD>         * @param b</TD></TR><TR><TD CLASS="l">228</TD><TD>         */</TD></TR><TR><TD CLASS="l">229</TD><TD>        public void setUnicodeStream(boolean unicodeStream) {</TD></TR><TR CLASS="z"><TD CLASS="l">230</TD><TD>                fUnicodeStream = unicodeStream;</TD></TR><TR><TD CLASS="l">231</TD><TD> </TD></TR><TR CLASS="z"><TD CLASS="l">232</TD><TD>        }</TD></TR><TR><TD CLASS="l">233</TD><TD> </TD></TR><TR><TD CLASS="l">234</TD><TD>        /**</TD></TR><TR><TD CLASS="l">235</TD><TD>         * Sets the uTF83ByteBOMfound.</TD></TR><TR><TD CLASS="l">236</TD><TD>         * </TD></TR><TR><TD CLASS="l"><A NAME="b">237</A></TD><TD>         * @param uTF83ByteBOMfound</TD></TR><TR><TD CLASS="l">238</TD><TD>         *            The uTF83ByteBOMfound to set</TD></TR><TR><TD CLASS="l">239</TD><TD>         */</TD></TR><TR><TD CLASS="l">240</TD><TD>        public void setUTF83ByteBOMUsed(boolean uTF83ByteBOMUsed) {</TD></TR><TR CLASS="z"><TD CLASS="l"><A NAME="c">241</A></TD><TD>                fUTF83ByteBOMUsed = uTF83ByteBOMUsed;</TD></TR><TR CLASS="z"><TD CLASS="l">242</TD><TD>        }</TD></TR><TR><TD CLASS="l">243</TD><TD> </TD></TR><TR><TD CLASS="l">244</TD><TD>        public void setUnicodeBOM(byte[] bom) {</TD></TR><TR CLASS="z"><TD CLASS="l">245</TD><TD>                fBOM = bom;</TD></TR><TR CLASS="z"><TD CLASS="l">246</TD><TD>        }</TD></TR><TR><TD CLASS="l">247</TD><TD>}</TD></TR></TABLE><P></P><TABLE CLASS="hdft" CELLSPACING="0" WIDTH="100%"><TR><TD CLASS="nv">[<A HREF="../xslUnitTestCoverage.html">all classes</A>][<A HREF="73.html">org.eclipse.wst.sse.core.internal.encoding</A>]</TD></TR><TR><TD CLASS="tl"><A HREF="http://www.eclemma.org/support.html">EMMA 2.0.5312 EclEmma Fix 1</A> (C) Vladimir Roubtsov</TD></TR></TABLE></BODY></HTML>