blob: 5f131743eb06494cb90bff480287009bd38b60a4 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: ElemDesc.java 468654 2006-10-28 07:09:23Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.serializer;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.xml.serializer.utils.StringToIntTable;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * This class has a series of flags (bit values) that describe an HTML element<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT> * This class is not a public API.<a name="line.28"></a>
<FONT color="green">029</FONT> * It is public because it is used outside of this package.<a name="line.29"></a>
<FONT color="green">030</FONT> * <a name="line.30"></a>
<FONT color="green">031</FONT> * @xsl.usage internal<a name="line.31"></a>
<FONT color="green">032</FONT> */<a name="line.32"></a>
<FONT color="green">033</FONT> public final class ElemDesc<a name="line.33"></a>
<FONT color="green">034</FONT> {<a name="line.34"></a>
<FONT color="green">035</FONT> /** Bit flags to tell about this element type. */<a name="line.35"></a>
<FONT color="green">036</FONT> private int m_flags;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /**<a name="line.38"></a>
<FONT color="green">039</FONT> * Table of attribute names to integers, which contain bit flags telling about<a name="line.39"></a>
<FONT color="green">040</FONT> * the attributes.<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> private StringToIntTable m_attrs = null;<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /** Bit position if this element type is empty. */<a name="line.44"></a>
<FONT color="green">045</FONT> static final int EMPTY = (1 &lt;&lt; 1);<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /** Bit position if this element type is a flow. */<a name="line.47"></a>
<FONT color="green">048</FONT> private static final int FLOW = (1 &lt;&lt; 2);<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /** Bit position if this element type is a block. */<a name="line.50"></a>
<FONT color="green">051</FONT> static final int BLOCK = (1 &lt;&lt; 3);<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /** Bit position if this element type is a block form. */<a name="line.53"></a>
<FONT color="green">054</FONT> static final int BLOCKFORM = (1 &lt;&lt; 4);<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /** Bit position if this element type is a block form field set. */<a name="line.56"></a>
<FONT color="green">057</FONT> static final int BLOCKFORMFIELDSET = (1 &lt;&lt; 5);<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> /** Bit position if this element type is CDATA. */<a name="line.59"></a>
<FONT color="green">060</FONT> private static final int CDATA = (1 &lt;&lt; 6);<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> /** Bit position if this element type is PCDATA. */<a name="line.62"></a>
<FONT color="green">063</FONT> private static final int PCDATA = (1 &lt;&lt; 7);<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /** Bit position if this element type is should be raw characters. */<a name="line.65"></a>
<FONT color="green">066</FONT> static final int RAW = (1 &lt;&lt; 8);<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> /** Bit position if this element type should be inlined. */<a name="line.68"></a>
<FONT color="green">069</FONT> private static final int INLINE = (1 &lt;&lt; 9);<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> /** Bit position if this element type is INLINEA. */<a name="line.71"></a>
<FONT color="green">072</FONT> private static final int INLINEA = (1 &lt;&lt; 10);<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> /** Bit position if this element type is an inline label. */<a name="line.74"></a>
<FONT color="green">075</FONT> static final int INLINELABEL = (1 &lt;&lt; 11);<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /** Bit position if this element type is a font style. */<a name="line.77"></a>
<FONT color="green">078</FONT> static final int FONTSTYLE = (1 &lt;&lt; 12);<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> /** Bit position if this element type is a phrase. */<a name="line.80"></a>
<FONT color="green">081</FONT> static final int PHRASE = (1 &lt;&lt; 13);<a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> /** Bit position if this element type is a form control. */<a name="line.83"></a>
<FONT color="green">084</FONT> static final int FORMCTRL = (1 &lt;&lt; 14);<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> /** Bit position if this element type is ???. */<a name="line.86"></a>
<FONT color="green">087</FONT> static final int SPECIAL = (1 &lt;&lt; 15);<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> /** Bit position if this element type is ???. */<a name="line.89"></a>
<FONT color="green">090</FONT> static final int ASPECIAL = (1 &lt;&lt; 16);<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> /** Bit position if this element type is an odd header element. */<a name="line.92"></a>
<FONT color="green">093</FONT> static final int HEADMISC = (1 &lt;&lt; 17);<a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> /** Bit position if this element type is a head element (i.e. H1, H2, etc.) */<a name="line.95"></a>
<FONT color="green">096</FONT> static final int HEAD = (1 &lt;&lt; 18);<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> /** Bit position if this element type is a list. */<a name="line.98"></a>
<FONT color="green">099</FONT> static final int LIST = (1 &lt;&lt; 19);<a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> /** Bit position if this element type is a preformatted type. */<a name="line.101"></a>
<FONT color="green">102</FONT> static final int PREFORMATTED = (1 &lt;&lt; 20);<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> /** Bit position if this element type is whitespace sensitive. */<a name="line.104"></a>
<FONT color="green">105</FONT> static final int WHITESPACESENSITIVE = (1 &lt;&lt; 21);<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> /** Bit position if this element type is a header element (i.e. HEAD). */<a name="line.107"></a>
<FONT color="green">108</FONT> static final int HEADELEM = (1 &lt;&lt; 22);<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> /** Bit position if this element is the "HTML" element */<a name="line.110"></a>
<FONT color="green">111</FONT> static final int HTMLELEM = (1 &lt;&lt; 23);<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> /** Bit position if this attribute type is a URL. */<a name="line.113"></a>
<FONT color="green">114</FONT> public static final int ATTRURL = (1 &lt;&lt; 1);<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> /** Bit position if this attribute type is an empty type. */<a name="line.116"></a>
<FONT color="green">117</FONT> public static final int ATTREMPTY = (1 &lt;&lt; 2);<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> /**<a name="line.119"></a>
<FONT color="green">120</FONT> * Construct an ElemDesc from a set of bit flags.<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> *<a name="line.122"></a>
<FONT color="green">123</FONT> * @param flags Bit flags that describe the basic properties of this element type.<a name="line.123"></a>
<FONT color="green">124</FONT> */<a name="line.124"></a>
<FONT color="green">125</FONT> ElemDesc(int flags)<a name="line.125"></a>
<FONT color="green">126</FONT> {<a name="line.126"></a>
<FONT color="green">127</FONT> m_flags = flags;<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> /**<a name="line.130"></a>
<FONT color="green">131</FONT> * Tell if this element type has the basic bit properties that are passed<a name="line.131"></a>
<FONT color="green">132</FONT> * as an argument.<a name="line.132"></a>
<FONT color="green">133</FONT> *<a name="line.133"></a>
<FONT color="green">134</FONT> * @param flags Bit flags that describe the basic properties of interest.<a name="line.134"></a>
<FONT color="green">135</FONT> *<a name="line.135"></a>
<FONT color="green">136</FONT> * @return true if any of the flag bits are true.<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> private boolean is(int flags)<a name="line.138"></a>
<FONT color="green">139</FONT> {<a name="line.139"></a>
<FONT color="green">140</FONT> <a name="line.140"></a>
<FONT color="green">141</FONT> // int which = (m_flags &amp; flags);<a name="line.141"></a>
<FONT color="green">142</FONT> return (m_flags &amp; flags) != 0;<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> <a name="line.144"></a>
<FONT color="green">145</FONT> int getFlags() {<a name="line.145"></a>
<FONT color="green">146</FONT> return m_flags;<a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * Set an attribute name and it's bit properties.<a name="line.150"></a>
<FONT color="green">151</FONT> *<a name="line.151"></a>
<FONT color="green">152</FONT> *<a name="line.152"></a>
<FONT color="green">153</FONT> * @param name non-null name of attribute, in upper case.<a name="line.153"></a>
<FONT color="green">154</FONT> * @param flags flag bits.<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> void setAttr(String name, int flags)<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> if (null == m_attrs)<a name="line.159"></a>
<FONT color="green">160</FONT> m_attrs = new StringToIntTable();<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> m_attrs.put(name, flags);<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> /**<a name="line.165"></a>
<FONT color="green">166</FONT> * Tell if any of the bits of interest are set for a named attribute type.<a name="line.166"></a>
<FONT color="green">167</FONT> *<a name="line.167"></a>
<FONT color="green">168</FONT> * @param name non-null reference to attribute name, in any case.<a name="line.168"></a>
<FONT color="green">169</FONT> * @param flags flag mask.<a name="line.169"></a>
<FONT color="green">170</FONT> *<a name="line.170"></a>
<FONT color="green">171</FONT> * @return true if any of the flags are set for the named attribute.<a name="line.171"></a>
<FONT color="green">172</FONT> */<a name="line.172"></a>
<FONT color="green">173</FONT> public boolean isAttrFlagSet(String name, int flags)<a name="line.173"></a>
<FONT color="green">174</FONT> {<a name="line.174"></a>
<FONT color="green">175</FONT> return (null != m_attrs)<a name="line.175"></a>
<FONT color="green">176</FONT> ? ((m_attrs.getIgnoreCase(name) &amp; flags) != 0)<a name="line.176"></a>
<FONT color="green">177</FONT> : false;<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> }<a name="line.179"></a>
</PRE>
</BODY>
</HTML>