scripting/java/docs/com/easysw/cups/IPPValue.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc on Tue Feb 11 14:29:07 PST 2003 -->
   6 <TITLE>
   7 : Class  IPPValue
   8 </TITLE>
   9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  10 </HEAD>
  11 <BODY BGCOLOR="white">
  12
  13 <!-- ========== START OF NAVBAR ========== -->
  14 <A NAME="navbar_top"><!-- --></A>
  15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  16 <TR>
  17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  18 <A NAME="navbar_top_firstrow"><!-- --></A>
  19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  20   <TR ALIGN="center" VALIGN="top">
  21   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  22   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  23   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  24   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  25   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  26   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  27   </TR>
  28 </TABLE>
  29 </TD>
  30 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  31 </EM>
  32 </TD>
  33 </TR>
  34
  35 <TR>
  36 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  37 &nbsp;<A HREF="../../../com/easysw/cups/IPPURLConnection.html"><B>PREV CLASS</B></A>&nbsp;
  38 &nbsp;NEXT CLASS</FONT></TD>
  39 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  40   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  41 &nbsp;<A HREF="IPPValue.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  42 </TR>
  43 <TR>
  44 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  45   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  46 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  47 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  48 </TR>
  49 </TABLE>
  50 <!-- =========== END OF NAVBAR =========== -->
  51
  52 <HR>
  53 <!-- ======== START OF CLASS DATA ======== -->
  54 <H2>
  55 <FONT SIZE="-1">
  56 com.easysw.cups</FONT>
  57 <BR>
  58 Class  IPPValue</H2>
  59 <PRE>
  60 java.lang.Object
  61   |
  62   +--<B>com.easysw.cups.IPPValue</B>
  63 </PRE>
  64 <HR>
  65 <DL>
  66 <DT>public class <B>IPPValue</B><DT>extends java.lang.Object</DL>
  67
  68 <P>
  69 <HR>
  70
  71 <P>
  72 <!-- ======== INNER CLASS SUMMARY ======== -->
  73
  74
  75 <!-- =========== FIELD SUMMARY =========== -->
  76
  77
  78 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  79
  80 <A NAME="constructor_summary"><!-- --></A>
  81 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  82 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  83 <TD COLSPAN=2><FONT SIZE="+2">
  84 <B>Constructor Summary</B></FONT></TD>
  85 </TR>
  86 <TR BGCOLOR="white" CLASS="TableRowColor">
  87 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(boolean)">IPPValue</A></B>(boolean&nbsp;p_boolean)</CODE>
  88
  89 <BR>
  90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean constructor.</TD>
  91 </TR>
  92 <TR BGCOLOR="white" CLASS="TableRowColor">
  93 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(byte)">IPPValue</A></B>(byte&nbsp;p_byte)</CODE>
  94
  95 <BR>
  96 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Byte constructor.</TD>
  97 </TR>
  98 <TR BGCOLOR="white" CLASS="TableRowColor">
  99 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(byte, int, int)">IPPValue</A></B>(byte&nbsp;p_units,
 100          int&nbsp;p_xres,
 101          int&nbsp;p_yres)</CODE>
 102
 103 <BR>
 104 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resolution constructor.</TD>
 105 </TR>
 106 <TR BGCOLOR="white" CLASS="TableRowColor">
 107 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(char[])">IPPValue</A></B>(char[]&nbsp;p_date)</CODE>
 108
 109 <BR>
 110 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Date constructor.</TD>
 111 </TR>
 112 <TR BGCOLOR="white" CLASS="TableRowColor">
 113 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(int)">IPPValue</A></B>(int&nbsp;p_int)</CODE>
 114
 115 <BR>
 116 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Integer constructor.</TD>
 117 </TR>
 118 <TR BGCOLOR="white" CLASS="TableRowColor">
 119 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(int, boolean)">IPPValue</A></B>(int&nbsp;p_int,
 120          boolean&nbsp;anything)</CODE>
 121
 122 <BR>
 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enum constructor.</TD>
 124 </TR>
 125 <TR BGCOLOR="white" CLASS="TableRowColor">
 126 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(int, char[])">IPPValue</A></B>(int&nbsp;p_length,
 127          char[]&nbsp;p_data)</CODE>
 128
 129 <BR>
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Raw data constructor.</TD>
 131 </TR>
 132 <TR BGCOLOR="white" CLASS="TableRowColor">
 133 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(int, int)">IPPValue</A></B>(int&nbsp;p_lower,
 134          int&nbsp;p_upper)</CODE>
 135
 136 <BR>
 137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Range constructor.</TD>
 138 </TR>
 139 <TR BGCOLOR="white" CLASS="TableRowColor">
 140 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(short)">IPPValue</A></B>(short&nbsp;p_short)</CODE>
 141
 142 <BR>
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Short constructor.</TD>
 144 </TR>
 145 <TR BGCOLOR="white" CLASS="TableRowColor">
 146 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPValue(java.lang.String, java.lang.String)">IPPValue</A></B>(java.lang.String&nbsp;p_charset,
 147          java.lang.String&nbsp;p_text)</CODE>
 148
 149 <BR>
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;String constructor.</TD>
 151 </TR>
 152 </TABLE>
 153 &nbsp;
 154 <!-- ========== METHOD SUMMARY =========== -->
 155
 156 <A NAME="method_summary"><!-- --></A>
 157 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 159 <TD COLSPAN=2><FONT SIZE="+2">
 160 <B>Method Summary</B></FONT></TD>
 161 </TR>
 162 <TR BGCOLOR="white" CLASS="TableRowColor">
 163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 164 <CODE>&nbsp;long</CODE></FONT></TD>
 165 <TD><CODE><B><A HREF="../../../com/easysw/cups/IPPValue.html#IPPDateToTime()">IPPDateToTime</A></B>()</CODE>
 166
 167 <BR>
 168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert an IPP Date value to Unix Time.</TD>
 169 </TR>
 170 </TABLE>
 171 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 172 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 173 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 174 <TD><B>Methods inherited from class java.lang.Object</B></TD>
 175 </TR>
 176 <TR BGCOLOR="white" CLASS="TableRowColor">
 177 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 178 </TR>
 179 </TABLE>
 180 &nbsp;
 181 <P>
 182
 183 <!-- ============ FIELD DETAIL =========== -->
 184
 185
 186 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 187
 188 <A NAME="constructor_detail"><!-- --></A>
 189 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 191 <TD COLSPAN=1><FONT SIZE="+2">
 192 <B>Constructor Detail</B></FONT></TD>
 193 </TR>
 194 </TABLE>
 195
 196 <A NAME="IPPValue(byte)"><!-- --></A><H3>
 197 IPPValue</H3>
 198 <PRE>
 199 public <B>IPPValue</B>(byte&nbsp;p_byte)</PRE>
 200 <DL>
 201 <DD>Byte constructor.<DD><DL>
 202 <DT><B>Parameters:</B><DD><CODE><code>p_byte</code></CODE> - Byte value.</DL>
 203 </DD>
 204 </DL>
 205 <HR>
 206
 207 <A NAME="IPPValue(short)"><!-- --></A><H3>
 208 IPPValue</H3>
 209 <PRE>
 210 public <B>IPPValue</B>(short&nbsp;p_short)</PRE>
 211 <DL>
 212 <DD>Short constructor.<DD><DL>
 213 <DT><B>Parameters:</B><DD><CODE><code>p_short</code></CODE> - Short value.</DL>
 214 </DD>
 215 </DL>
 216 <HR>
 217
 218 <A NAME="IPPValue(int)"><!-- --></A><H3>
 219 IPPValue</H3>
 220 <PRE>
 221 public <B>IPPValue</B>(int&nbsp;p_int)</PRE>
 222 <DL>
 223 <DD>Integer constructor.<DD><DL>
 224 <DT><B>Parameters:</B><DD><CODE><code>p_int</code></CODE> - Integer value.</DL>
 225 </DD>
 226 </DL>
 227 <HR>
 228
 229 <A NAME="IPPValue(int, boolean)"><!-- --></A><H3>
 230 IPPValue</H3>
 231 <PRE>
 232 public <B>IPPValue</B>(int&nbsp;p_int,
 233                 boolean&nbsp;anything)</PRE>
 234 <DL>
 235 <DD>Enum constructor.<DD><DL>
 236 <DT><B>Parameters:</B><DD><CODE><code>p_int</code></CODE> - Integer value - force to IPP enum.</DL>
 237 </DD>
 238 </DL>
 239 <HR>
 240
 241 <A NAME="IPPValue(boolean)"><!-- --></A><H3>
 242 IPPValue</H3>
 243 <PRE>
 244 public <B>IPPValue</B>(boolean&nbsp;p_boolean)</PRE>
 245 <DL>
 246 <DD>Boolean constructor.<DD><DL>
 247 <DT><B>Parameters:</B><DD><CODE><code>p_boolean</code></CODE> - Boolean value.</DL>
 248 </DD>
 249 </DL>
 250 <HR>
 251
 252 <A NAME="IPPValue(char[])"><!-- --></A><H3>
 253 IPPValue</H3>
 254 <PRE>
 255 public <B>IPPValue</B>(char[]&nbsp;p_date)</PRE>
 256 <DL>
 257 <DD>Date constructor.  Also set the <code>unix_time</code> member.<DD><DL>
 258 <DT><B>Parameters:</B><DD><CODE><code>p_date[]</code></CODE> - Character array with date value.</DL>
 259 </DD>
 260 </DL>
 261 <HR>
 262
 263 <A NAME="IPPValue(java.lang.String, java.lang.String)"><!-- --></A><H3>
 264 IPPValue</H3>
 265 <PRE>
 266 public <B>IPPValue</B>(java.lang.String&nbsp;p_charset,
 267                 java.lang.String&nbsp;p_text)</PRE>
 268 <DL>
 269 <DD>String constructor.  Set the <code>string</code> and
 270   <code>charset</code> values.<DD><DL>
 271 <DT><B>Parameters:</B><DD><CODE><code>p_charset</code></CODE> - Charset for string.<DD><CODE><code>p_text</code></CODE> - Text for string.</DL>
 272 </DD>
 273 </DL>
 274 <HR>
 275
 276 <A NAME="IPPValue(int, int)"><!-- --></A><H3>
 277 IPPValue</H3>
 278 <PRE>
 279 public <B>IPPValue</B>(int&nbsp;p_lower,
 280                 int&nbsp;p_upper)</PRE>
 281 <DL>
 282 <DD>Range constructor.  Automatically swap as needed.<DD><DL>
 283 <DT><B>Parameters:</B><DD><CODE><code>p_lower</code></CODE> - Integer lower value.<DD><CODE><code>p_upper</code></CODE> - Integer upper value.</DL>
 284 </DD>
 285 </DL>
 286 <HR>
 287
 288 <A NAME="IPPValue(byte, int, int)"><!-- --></A><H3>
 289 IPPValue</H3>
 290 <PRE>
 291 public <B>IPPValue</B>(byte&nbsp;p_units,
 292                 int&nbsp;p_xres,
 293                 int&nbsp;p_yres)</PRE>
 294 <DL>
 295 <DD>Resolution constructor.<DD><DL>
 296 <DT><B>Parameters:</B><DD><CODE><code>p_units</code></CODE> - Unit of measure.<DD><CODE><code>p_xres</code></CODE> - X resolution.<DD><CODE><code>p_yres</code></CODE> - Y resolution.</DL>
 297 </DD>
 298 </DL>
 299 <HR>
 300
 301 <A NAME="IPPValue(int, char[])"><!-- --></A><H3>
 302 IPPValue</H3>
 303 <PRE>
 304 public <B>IPPValue</B>(int&nbsp;p_length,
 305                 char[]&nbsp;p_data)</PRE>
 306 <DL>
 307 <DD>Raw data constructor.<DD><DL>
 308 <DT><B>Parameters:</B><DD><CODE><code>p_length</code></CODE> - Size of array.<DD><CODE><code>p_data[]</code></CODE> - Data.</DL>
 309 </DD>
 310 </DL>
 311
 312 <!-- ============ METHOD DETAIL ========== -->
 313
 314 <A NAME="method_detail"><!-- --></A>
 315 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 316 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 317 <TD COLSPAN=1><FONT SIZE="+2">
 318 <B>Method Detail</B></FONT></TD>
 319 </TR>
 320 </TABLE>
 321
 322 <A NAME="IPPDateToTime()"><!-- --></A><H3>
 323 IPPDateToTime</H3>
 324 <PRE>
 325 public long <B>IPPDateToTime</B>()</PRE>
 326 <DL>
 327 <DD>Convert an IPP Date value to Unix Time.<DD><DL>
 328 <DT><B>Returns:</B><DD><code>long</code>        Unix time in seconds.<DT><B>See Also: </B><DD><code>IPPCalender</code></DL>
 329 </DD>
 330 </DL>
 331 <!-- ========= END OF CLASS DATA ========= -->
 332 <HR>
 333
 334 <!-- ========== START OF NAVBAR ========== -->
 335 <A NAME="navbar_bottom"><!-- --></A>
 336 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 337 <TR>
 338 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 339 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 340 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 341   <TR ALIGN="center" VALIGN="top">
 342   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 343   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 344   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 345   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 346   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 347   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 348   </TR>
 349 </TABLE>
 350 </TD>
 351 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 352 </EM>
 353 </TD>
 354 </TR>
 355
 356 <TR>
 357 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 358 &nbsp;<A HREF="../../../com/easysw/cups/IPPURLConnection.html"><B>PREV CLASS</B></A>&nbsp;
 359 &nbsp;NEXT CLASS</FONT></TD>
 360 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 361   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 362 &nbsp;<A HREF="IPPValue.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 363 </TR>
 364 <TR>
 365 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 366   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 367 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 368 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 369 </TR>
 370 </TABLE>
 371 <!-- =========== END OF NAVBAR =========== -->
 372
 373 <HR>
 374
 375 </BODY>
 376 </HTML>