1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
5 <!-- Generated by javadoc on Tue Feb 11 14:29:07 PST 2003 -->
9 <LINK REL =
"stylesheet" TYPE=
"text/css" HREF=
"../../../stylesheet.css" TITLE=
"Style">
11 <BODY BGCOLOR=
"white">
13 <!-- ========== START OF NAVBAR ========== -->
14 <A NAME=
"navbar_top"><!-- --></A>
15 <TABLE BORDER=
"0" WIDTH=
"100%" CELLPADDING=
"1" CELLSPACING=
"0">
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> </TD>
22 <TD BGCOLOR=
"#FFFFFF" CLASS=
"NavBarCell1Rev"> <FONT CLASS=
"NavBarFont1Rev"><B>Class
</B></FONT> </TD>
23 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-tree.html"><FONT CLASS=
"NavBarFont1"><B>Tree
</B></FONT></A> </TD>
24 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../deprecated-list.html"><FONT CLASS=
"NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
25 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../index-all.html"><FONT CLASS=
"NavBarFont1"><B>Index
</B></FONT></A> </TD>
26 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../help-doc.html"><FONT CLASS=
"NavBarFont1"><B>Help
</B></FONT></A> </TD>
30 <TD ALIGN=
"right" VALIGN=
"top" ROWSPAN=
3><EM>
36 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
37 <A HREF=
"../../../com/easysw/cups/CupsPrinter.html"><B>PREV CLASS
</B></A>
38 <A HREF=
"../../../com/easysw/cups/IPPAttribute.html"><B>NEXT CLASS
</B></A></FONT></TD>
39 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
40 <A HREF=
"../../../index.html" TARGET=
"_top"><B>FRAMES
</B></A>
41 <A HREF=
"IPP.html" TARGET=
"_top"><B>NO FRAMES
</B></A></FONT></TD>
44 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
45 SUMMARY:
INNER
|
<A HREF=
"#field_summary">FIELD
</A> |
<A HREF=
"#constructor_summary">CONSTR
</A> |
<A HREF=
"#method_summary">METHOD
</A></FONT></TD>
46 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
47 DETAIL:
<A HREF=
"#field_detail">FIELD
</A> |
<A HREF=
"#constructor_detail">CONSTR
</A> |
<A HREF=
"#method_detail">METHOD
</A></FONT></TD>
50 <!-- =========== END OF NAVBAR =========== -->
53 <!-- ======== START OF CLASS DATA ======== -->
56 com.easysw.cups
</FONT>
62 +--
<B>com.easysw.cups.IPP
</B>
66 <DT>public class
<B>IPP
</B><DT>extends java.lang.Object
</DL>
69 An
<code>IPP
</code> object is used to hold the various
70 attributes and status of an ipp request..
73 <DT><B>Since:
</B><DD>JDK1.3
</DD>
78 <!-- ======== INNER CLASS SUMMARY ======== -->
81 <!-- =========== FIELD SUMMARY =========== -->
83 <A NAME=
"field_summary"><!-- --></A>
84 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
85 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
86 <TD COLSPAN=
2><FONT SIZE=
"+2">
87 <B>Field Summary
</B></FONT></TD>
89 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
90 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
91 <CODE> java.util.List
</CODE></FONT></TD>
92 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#attrs">attrs
</A></B></CODE>
95 </TD>
97 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
98 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
99 <CODE> <A HREF=
"../../../com/easysw/cups/IPPRequest.html">IPPRequest
</A></CODE></FONT></TD>
100 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#request">request
</A></B></CODE>
103 </TD>
105 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
106 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
107 <CODE> <A HREF=
"../../../com/easysw/cups/IPPStatus.html">IPPStatus
</A></CODE></FONT></TD>
108 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#status">status
</A></B></CODE>
111 </TD>
115 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
117 <A NAME=
"constructor_summary"><!-- --></A>
118 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
119 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
120 <TD COLSPAN=
2><FONT SIZE=
"+2">
121 <B>Constructor Summary
</B></FONT></TD>
123 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
124 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#IPP()">IPP
</A></B>()
</CODE>
127 </TD>
131 <!-- ========== METHOD SUMMARY =========== -->
133 <A NAME=
"method_summary"><!-- --></A>
134 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
135 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
136 <TD COLSPAN=
2><FONT SIZE=
"+2">
137 <B>Method Summary
</B></FONT></TD>
139 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
140 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
141 <CODE> boolean
</CODE></FONT></TD>
142 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#addAttribute(com.easysw.cups.IPPAttribute)">addAttribute
</A></B>(
<A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A> a)
</CODE>
145 Add an attribute to the attibutes list
146 for later parsing.
</TD>
148 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
149 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
150 <CODE> void
</CODE></FONT></TD>
151 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#dump_response()">dump_response
</A></B>()
</CODE>
154 </TD>
156 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
157 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
158 <CODE> <A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A></CODE></FONT></TD>
159 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#getCurrentAttribute()">getCurrentAttribute
</A></B>()
</CODE>
162 Get the current attribute pointed at by
163 <code>current
</code>.
</TD>
165 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
166 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
167 <CODE> <A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A></CODE></FONT></TD>
168 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#ippFindAttribute(java.lang.String, int)">ippFindAttribute
</A></B>(java.lang.String
p_name,
169 int
p_type)
</CODE>
172 Find the named attribute of the correct type.
</TD>
174 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
175 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
176 <CODE> <A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A></CODE></FONT></TD>
177 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#ippFindNextAttribute(java.lang.String, int)">ippFindNextAttribute
</A></B>(java.lang.String
p_name,
178 int
p_type)
</CODE>
181 Find the named attribute of the correct type.
</TD>
183 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
184 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
185 <CODE> void
</CODE></FONT></TD>
186 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#setRequestID(short)">setRequestID
</A></B>(short
p_id)
</CODE>
189 Set the
<code>IPP
</code> request ID.
</TD>
191 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
192 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
193 <CODE> void
</CODE></FONT></TD>
194 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#setRequestOperationID(short)">setRequestOperationID
</A></B>(short
p_operation_id)
</CODE>
197 Set the
<code>IPP
</code> operation ID.
</TD>
199 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
200 <TD ALIGN=
"right" VALIGN=
"top" WIDTH=
"1%"><FONT SIZE=
"-1">
201 <CODE> int
</CODE></FONT></TD>
202 <TD><CODE><B><A HREF=
"../../../com/easysw/cups/IPP.html#sizeInBytes()">sizeInBytes
</A></B>()
</CODE>
205 Get the size in bytes of an
<code>IPP
</code> request.
</TD>
208 <A NAME=
"methods_inherited_from_class_java.lang.Object"><!-- --></A>
209 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
210 <TR BGCOLOR=
"#EEEEFF" CLASS=
"TableSubHeadingColor">
211 <TD><B>Methods inherited from class java.lang.Object
</B></TD>
213 <TR BGCOLOR=
"white" CLASS=
"TableRowColor">
214 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</CODE></TD>
220 <!-- ============ FIELD DETAIL =========== -->
222 <A NAME=
"field_detail"><!-- --></A>
223 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
224 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
225 <TD COLSPAN=
1><FONT SIZE=
"+2">
226 <B>Field Detail
</B></FONT></TD>
230 <A NAME=
"request"><!-- --></A><H3>
233 public
<A HREF=
"../../../com/easysw/cups/IPPRequest.html">IPPRequest
</A> <B>request
</B></PRE>
238 <A NAME=
"status"><!-- --></A><H3>
241 public
<A HREF=
"../../../com/easysw/cups/IPPStatus.html">IPPStatus
</A> <B>status
</B></PRE>
246 <A NAME=
"attrs"><!-- --></A><H3>
249 public java.util.List
<B>attrs
</B></PRE>
253 <!-- ========= CONSTRUCTOR DETAIL ======== -->
255 <A NAME=
"constructor_detail"><!-- --></A>
256 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
257 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
258 <TD COLSPAN=
1><FONT SIZE=
"+2">
259 <B>Constructor Detail
</B></FONT></TD>
263 <A NAME=
"IPP()"><!-- --></A><H3>
266 public
<B>IPP
</B>()
</PRE>
270 <!-- ============ METHOD DETAIL ========== -->
272 <A NAME=
"method_detail"><!-- --></A>
273 <TABLE BORDER=
"1" CELLPADDING=
"3" CELLSPACING=
"0" WIDTH=
"100%">
274 <TR BGCOLOR=
"#CCCCFF" CLASS=
"TableHeadingColor">
275 <TD COLSPAN=
1><FONT SIZE=
"+2">
276 <B>Method Detail
</B></FONT></TD>
280 <A NAME=
"addAttribute(com.easysw.cups.IPPAttribute)"><!-- --></A><H3>
283 public boolean
<B>addAttribute
</B>(
<A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A> a)
</PRE>
285 <DD>Add an attribute to the attibutes list
286 for later parsing.
<DD><DL>
287 <DT><B>Parameters:
</B><DD><CODE>a
</CODE> -
<code>IPPAttribute
</code> to add.
<DT><B>Returns:
</B><DD><code>true
</code> always returns
<code>true
</code>
288 for now.
<DT><B>See Also:
</B><DD><A HREF=
"../../../com/easysw/cups/IPPAttribute.html"><CODE>IPPAttribute
</CODE></A>,
289 <A HREF=
"../../../com/easysw/cups/IPPValue.html"><CODE>IPPValue
</CODE></A></DL>
294 <A NAME=
"getCurrentAttribute()"><!-- --></A><H3>
295 getCurrentAttribute
</H3>
297 public
<A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A> <B>getCurrentAttribute
</B>()
</PRE>
299 <DD>Get the current attribute pointed at by
300 <code>current
</code>.
<DD><DL>
301 <DT><B>Returns:
</B><DD><code>IPPAttribute
</code> Return the current attribute.
</DL>
306 <A NAME=
"ippFindAttribute(java.lang.String, int)"><!-- --></A><H3>
307 ippFindAttribute
</H3>
309 public
<A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A> <B>ippFindAttribute
</B>(java.lang.String
p_name,
310 int
p_type)
</PRE>
312 <DD>Find the named attribute of the correct type. Both must match.
313 This methos searches from the beginning of the attribute list,
314 rather than from the current position.
<DD><DL>
315 <DT><B>Parameters:
</B><DD><CODE>p_name
</CODE> -
<code>String
</code> containing the name.
<DD><CODE>p_type
</CODE> -
<code>int
</code> attribute type.
<DT><B>Returns:
</B><DD><code>IPPAttribute
</code> Matching attribute if found.
</DL>
320 <A NAME=
"ippFindNextAttribute(java.lang.String, int)"><!-- --></A><H3>
321 ippFindNextAttribute
</H3>
323 public
<A HREF=
"../../../com/easysw/cups/IPPAttribute.html">IPPAttribute
</A> <B>ippFindNextAttribute
</B>(java.lang.String
p_name,
324 int
p_type)
</PRE>
326 <DD>Find the named attribute of the correct type. Both must match.
327 This methos searches from the current position in the attribute list.
<DD><DL>
328 <DT><B>Parameters:
</B><DD><CODE>p_name
</CODE> -
<code>String
</code> containing the name.
<DD><CODE>p_type
</CODE> -
<code>int
</code> attribute type.
<DT><B>Returns:
</B><DD><code>IPPAttribute
</code> Matching attribute if found.
</DL>
333 <A NAME=
"sizeInBytes()"><!-- --></A><H3>
336 public int
<B>sizeInBytes
</B>()
</PRE>
338 <DD>Get the size in bytes of an
<code>IPP
</code> request.
<DD><DL>
339 <DT><B>Returns:
</B><DD><code>int
</code> Number of bytes for the request.
</DL>
344 <A NAME=
"setRequestID(short)"><!-- --></A><H3>
347 public void
<B>setRequestID
</B>(short
p_id)
</PRE>
349 <DD>Set the
<code>IPP
</code> request ID.
<DD><DL>
350 <DT><B>Parameters:
</B><DD><CODE>p_id
</CODE> -
<code>short
</code> request id.
</DL>
355 <A NAME=
"setRequestOperationID(short)"><!-- --></A><H3>
356 setRequestOperationID
</H3>
358 public void
<B>setRequestOperationID
</B>(short
p_operation_id)
</PRE>
360 <DD>Set the
<code>IPP
</code> operation ID.
<DD><DL>
361 <DT><B>Parameters:
</B><DD><CODE>p_operation_id
</CODE> -
<code>short
</code> operation id.
</DL>
366 <A NAME=
"dump_response()"><!-- --></A><H3>
369 public void
<B>dump_response
</B>()
</PRE>
372 <!-- ========= END OF CLASS DATA ========= -->
375 <!-- ========== START OF NAVBAR ========== -->
376 <A NAME=
"navbar_bottom"><!-- --></A>
377 <TABLE BORDER=
"0" WIDTH=
"100%" CELLPADDING=
"1" CELLSPACING=
"0">
379 <TD COLSPAN=
2 BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1">
380 <A NAME=
"navbar_bottom_firstrow"><!-- --></A>
381 <TABLE BORDER=
"0" CELLPADDING=
"0" CELLSPACING=
"3">
382 <TR ALIGN=
"center" VALIGN=
"top">
383 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-summary.html"><FONT CLASS=
"NavBarFont1"><B>Package
</B></FONT></A> </TD>
384 <TD BGCOLOR=
"#FFFFFF" CLASS=
"NavBarCell1Rev"> <FONT CLASS=
"NavBarFont1Rev"><B>Class
</B></FONT> </TD>
385 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"package-tree.html"><FONT CLASS=
"NavBarFont1"><B>Tree
</B></FONT></A> </TD>
386 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../deprecated-list.html"><FONT CLASS=
"NavBarFont1"><B>Deprecated
</B></FONT></A> </TD>
387 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../index-all.html"><FONT CLASS=
"NavBarFont1"><B>Index
</B></FONT></A> </TD>
388 <TD BGCOLOR=
"#EEEEFF" CLASS=
"NavBarCell1"> <A HREF=
"../../../help-doc.html"><FONT CLASS=
"NavBarFont1"><B>Help
</B></FONT></A> </TD>
392 <TD ALIGN=
"right" VALIGN=
"top" ROWSPAN=
3><EM>
398 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
399 <A HREF=
"../../../com/easysw/cups/CupsPrinter.html"><B>PREV CLASS
</B></A>
400 <A HREF=
"../../../com/easysw/cups/IPPAttribute.html"><B>NEXT CLASS
</B></A></FONT></TD>
401 <TD BGCOLOR=
"white" CLASS=
"NavBarCell2"><FONT SIZE=
"-2">
402 <A HREF=
"../../../index.html" TARGET=
"_top"><B>FRAMES
</B></A>
403 <A HREF=
"IPP.html" TARGET=
"_top"><B>NO FRAMES
</B></A></FONT></TD>
406 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
407 SUMMARY:
INNER
|
<A HREF=
"#field_summary">FIELD
</A> |
<A HREF=
"#constructor_summary">CONSTR
</A> |
<A HREF=
"#method_summary">METHOD
</A></FONT></TD>
408 <TD VALIGN=
"top" CLASS=
"NavBarCell3"><FONT SIZE=
"-2">
409 DETAIL:
<A HREF=
"#field_detail">FIELD
</A> |
<A HREF=
"#constructor_detail">CONSTR
</A> |
<A HREF=
"#method_detail">METHOD
</A></FONT></TD>
412 <!-- =========== END OF NAVBAR =========== -->