/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/metatype/AttributeDefinition.html is in libosgi-compendium-java-doc 4.3.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 | <!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.6.0_23) on Mon Nov 21 22:05:27 UTC 2011 -->
<TITLE>
AttributeDefinition
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AttributeDefinition";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/osgi/service/metatype/MetaTypeInformation.html" title="interface in org.osgi.service.metatype"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/metatype/AttributeDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="AttributeDefinition.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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.osgi.service.metatype</FONT>
<BR>
Interface AttributeDefinition</H2>
<HR>
<DL>
<DT><PRE>public interface <B>AttributeDefinition</B></DL>
</PRE>
<P>
An interface to describe an attribute.
<p>
An <code>AttributeDefinition</code> object defines a description of the data type
of a property/attribute.
<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>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#BIGDECIMAL">BIGDECIMAL</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>As of 1.1.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#BIGINTEGER">BIGINTEGER</A></B></CODE>
<BR>
<B>Deprecated.</B> <I>As of 1.1.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#BOOLEAN">BOOLEAN</A></B></CODE>
<BR>
The <code>BOOLEAN</code> (11) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#BYTE">BYTE</A></B></CODE>
<BR>
The <code>BYTE</code> (6) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#CHARACTER">CHARACTER</A></B></CODE>
<BR>
The <code>CHARACTER</code> (5) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#DOUBLE">DOUBLE</A></B></CODE>
<BR>
The <code>DOUBLE</code> (7) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#FLOAT">FLOAT</A></B></CODE>
<BR>
The <code>FLOAT</code> (8) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#INTEGER">INTEGER</A></B></CODE>
<BR>
The <code>INTEGER</code> (3) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#LONG">LONG</A></B></CODE>
<BR>
The <code>LONG</code> (2) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#PASSWORD">PASSWORD</A></B></CODE>
<BR>
The <code>PASSWORD</code> (12) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#SHORT">SHORT</A></B></CODE>
<BR>
The <code>SHORT</code> (4) type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#STRING">STRING</A></B></CODE>
<BR>
The <code>STRING</code> (1) type.</TD>
</TR>
</TABLE>
<!-- ========== 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> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getCardinality()">getCardinality</A></B>()</CODE>
<BR>
Return the cardinality of this attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getDefaultValue()">getDefaultValue</A></B>()</CODE>
<BR>
Return a default for this attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getDescription()">getDescription</A></B>()</CODE>
<BR>
Return a description of this attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getID()">getID</A></B>()</CODE>
<BR>
Unique identity for this attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getName()">getName</A></B>()</CODE>
<BR>
Get the name of the attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getOptionLabels()">getOptionLabels</A></B>()</CODE>
<BR>
Return a list of labels of option values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getOptionValues()">getOptionValues</A></B>()</CODE>
<BR>
Return a list of option values that this attribute can take.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#getType()">getType</A></B>()</CODE>
<BR>
Return the type for this attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/metatype/AttributeDefinition.html#validate(java.lang.String)">validate</A></B>(java.lang.String value)</CODE>
<BR>
Validate an attribute in <code>String</code> form.</TD>
</TR>
</TABLE>
<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="STRING"><!-- --></A><H3>
STRING</H3>
<PRE>
static final int <B>STRING</B></PRE>
<DL>
<DD>The <code>STRING</code> (1) type.
<p>
Attributes of this type should be stored as <code>String</code>,
<code>Vector</code> with <code>String</code> or <code>String[]</code> objects, depending
on the <code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.STRING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LONG"><!-- --></A><H3>
LONG</H3>
<PRE>
static final int <B>LONG</B></PRE>
<DL>
<DD>The <code>LONG</code> (2) type.
Attributes of this type should be stored as <code>Long</code>, <code>Vector</code>
with <code>Long</code> or <code>long[]</code> objects, depending on the
<code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.LONG">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INTEGER"><!-- --></A><H3>
INTEGER</H3>
<PRE>
static final int <B>INTEGER</B></PRE>
<DL>
<DD>The <code>INTEGER</code> (3) type.
Attributes of this type should be stored as <code>Integer</code>,
<code>Vector</code> with <code>Integer</code> or <code>int[]</code> objects, depending
on the <code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.INTEGER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHORT"><!-- --></A><H3>
SHORT</H3>
<PRE>
static final int <B>SHORT</B></PRE>
<DL>
<DD>The <code>SHORT</code> (4) type.
Attributes of this type should be stored as <code>Short</code>, <code>Vector</code>
with <code>Short</code> or <code>short[]</code> objects, depending on the
<code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.SHORT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CHARACTER"><!-- --></A><H3>
CHARACTER</H3>
<PRE>
static final int <B>CHARACTER</B></PRE>
<DL>
<DD>The <code>CHARACTER</code> (5) type.
Attributes of this type should be stored as <code>Character</code>,
<code>Vector</code> with <code>Character</code> or <code>char[]</code> objects,
depending on the <code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.CHARACTER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BYTE"><!-- --></A><H3>
BYTE</H3>
<PRE>
static final int <B>BYTE</B></PRE>
<DL>
<DD>The <code>BYTE</code> (6) type.
Attributes of this type should be stored as <code>Byte</code>, <code>Vector</code>
with <code>Byte</code> or <code>byte[]</code> objects, depending on the
<code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.BYTE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DOUBLE"><!-- --></A><H3>
DOUBLE</H3>
<PRE>
static final int <B>DOUBLE</B></PRE>
<DL>
<DD>The <code>DOUBLE</code> (7) type.
Attributes of this type should be stored as <code>Double</code>,
<code>Vector</code> with <code>Double</code> or <code>double[]</code> objects, depending
on the <code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.DOUBLE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FLOAT"><!-- --></A><H3>
FLOAT</H3>
<PRE>
static final int <B>FLOAT</B></PRE>
<DL>
<DD>The <code>FLOAT</code> (8) type.
Attributes of this type should be stored as <code>Float</code>, <code>Vector</code>
with <code>Float</code> or <code>float[]</code> objects, depending on the
<code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.FLOAT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BIGINTEGER"><!-- --></A><H3>
BIGINTEGER</H3>
<PRE>
static final int <B>BIGINTEGER</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>As of 1.1.</I><DD>The <code>BIGINTEGER</code> (9) type.
Attributes of this type should be stored as <code>BigInteger</code>,
<code>Vector</code> with <code>BigInteger</code> or <code>BigInteger[]</code> objects,
depending on the <code>getCardinality()</code> value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.BIGINTEGER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BIGDECIMAL"><!-- --></A><H3>
BIGDECIMAL</H3>
<PRE>
static final int <B>BIGDECIMAL</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>As of 1.1.</I><DD>The <code>BIGDECIMAL</code> (10) type.
Attributes of this type should be stored as <code>BigDecimal</code>,
<code>Vector</code> with <code>BigDecimal</code> or <code>BigDecimal[]</code> objects
depending on <code>getCardinality()</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.BIGDECIMAL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BOOLEAN"><!-- --></A><H3>
BOOLEAN</H3>
<PRE>
static final int <B>BOOLEAN</B></PRE>
<DL>
<DD>The <code>BOOLEAN</code> (11) type.
Attributes of this type should be stored as <code>Boolean</code>,
<code>Vector</code> with <code>Boolean</code> or <code>boolean[]</code> objects
depending on <code>getCardinality()</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.BOOLEAN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PASSWORD"><!-- --></A><H3>
PASSWORD</H3>
<PRE>
static final int <B>PASSWORD</B></PRE>
<DL>
<DD>The <code>PASSWORD</code> (12) type.
Attributes of this type must be stored as <code>String</code>, <code>Vector</code>
with <code>String</code> or <code>String[]</code> objects depending on {link
getCardinality()}. A <code>PASSWORD</code> must be treated as a string but the
type can be used to disguise the information when displayed to a user to
prevent others from seeing it.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.metatype.AttributeDefinition.PASSWORD">Constant Field Values</A></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="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get the name of the attribute. This name may be localized.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The localized name of the definition.</DL>
</DD>
</DL>
<HR>
<A NAME="getID()"><!-- --></A><H3>
getID</H3>
<PRE>
java.lang.String <B>getID</B>()</PRE>
<DL>
<DD>Unique identity for this attribute.
Attributes share a global namespace in the registry. E.g. an attribute
<code>cn</code> or <code>commonName</code> must always be a <code>String</code> and the
semantics are always a name of some object. They share this aspect with
LDAP/X.500 attributes. In these standards the OSI Object Identifier (OID)
is used to uniquely identify an attribute. If such an OID exists, (which
can be requested at several standard organisations and many companies
already have a node in the tree) it can be returned here. Otherwise, a
unique id should be returned which can be a Java class name (reverse
domain name) or generated with a GUID algorithm. Note that all LDAP
defined attributes already have an OID. It is strongly advised to define
the attributes from existing LDAP schemes which will give the OID. Many
such schemes exist ranging from postal addresses to DHCP parameters.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The id or oid</DL>
</DD>
</DL>
<HR>
<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
java.lang.String <B>getDescription</B>()</PRE>
<DL>
<DD>Return a description of this attribute.
The description may be localized and must describe the semantics of this
type and any constraints.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The localized description of the definition.</DL>
</DD>
</DL>
<HR>
<A NAME="getCardinality()"><!-- --></A><H3>
getCardinality</H3>
<PRE>
int <B>getCardinality</B>()</PRE>
<DL>
<DD>Return the cardinality of this attribute.
The OSGi environment handles multi valued attributes in arrays ([]) or in
<code>Vector</code> objects. The return value is defined as follows:
<pre>
x = Integer.MIN_VALUE no limit, but use Vector
x < 0 -x = max occurrences, store in Vector
x > 0 x = max occurrences, store in array []
x = Integer.MAX_VALUE no limit, but use array []
x = 0 1 occurrence required
</pre>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The cardinality of this attribute.</DL>
</DD>
</DL>
<HR>
<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
int <B>getType</B>()</PRE>
<DL>
<DD>Return the type for this attribute.
<p>
Defined in the following constants which map to the appropriate Java
type. <code>STRING</code>,<code>LONG</code>,<code>INTEGER</code>, <code>CHAR</code>,
<code>BYTE</code>,<code>DOUBLE</code>,<code>FLOAT</code>, <code>BOOLEAN</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The type for this attribute.</DL>
</DD>
</DL>
<HR>
<A NAME="getOptionValues()"><!-- --></A><H3>
getOptionValues</H3>
<PRE>
java.lang.String[] <B>getOptionValues</B>()</PRE>
<DL>
<DD>Return a list of option values that this attribute can take.
<p>
If the function returns <code>null</code>, there are no option values
available.
<p>
Each value must be acceptable to validate() (return "") and must be a
<code>String</code> object that can be converted to the data type defined by
getType() for this attribute.
<p>
This list must be in the same sequence as <code>getOptionLabels()</code>. I.e.
for each index i in <code>getOptionValues</code>, i in
<code>getOptionLabels()</code> should be the label.
<p>
For example, if an attribute can have the value male, female, unknown,
this list can return
<code>new String[] { "male", "female", "unknown" }</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A list values</DL>
</DD>
</DL>
<HR>
<A NAME="getOptionLabels()"><!-- --></A><H3>
getOptionLabels</H3>
<PRE>
java.lang.String[] <B>getOptionLabels</B>()</PRE>
<DL>
<DD>Return a list of labels of option values.
<p>
The purpose of this method is to allow menus with localized labels. It is
associated with <code>getOptionValues</code>. The labels returned here are
ordered in the same way as the values in that method.
<p>
If the function returns <code>null</code>, there are no option labels
available.
<p>
This list must be in the same sequence as the <code>getOptionValues()</code>
method. I.e. for each index i in <code>getOptionLabels</code>, i in
<code>getOptionValues()</code> should be the associated value.
<p>
For example, if an attribute can have the value male, female, unknown,
this list can return (for dutch)
<code>new String[] { "Man", "Vrouw", "Onbekend" }</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A list values</DL>
</DD>
</DL>
<HR>
<A NAME="validate(java.lang.String)"><!-- --></A><H3>
validate</H3>
<PRE>
java.lang.String <B>validate</B>(java.lang.String value)</PRE>
<DL>
<DD>Validate an attribute in <code>String</code> form.
An attribute might be further constrained in value. This method will
attempt to validate the attribute according to these constraints. It can
return three different values:
<pre>
null No validation present
"" No problems detected
"..." A localized description of why the value is wrong
</pre>
If the cardinality of this attribute is multi-valued then this string
must be interpreted as a comma delimited string. The complete value must
be trimmed from white space as well as spaces around commas. Commas (','
,) and spaces (' ' ) and back-slashes ('\' \) can be escaped
with another back-slash. Escaped spaces must not be trimmed. For example:
<pre>
value=" a\,b,b\,c,\ c\\,d " => [ "a,b", "b,c", " c\", "d" ]
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The value before turning it into the basic data type. If the
cardinality indicates a multi valued attribute then the given
string must be escap
<DT><B>Returns:</B><DD><code>null</code>, "", or another string</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultValue()"><!-- --></A><H3>
getDefaultValue</H3>
<PRE>
java.lang.String[] <B>getDefaultValue</B>()</PRE>
<DL>
<DD>Return a default for this attribute.
The object must be of the appropriate type as defined by the cardinality
and <code>getType()</code>. The return type is a list of <code>String</code>
objects that can be converted to the appropriate type. The cardinality of
the return array must follow the absolute cardinality of this type. E.g.
if the cardinality = 0, the array must contain 1 element. If the
cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must
contain from 0 to max 5 elements. Note that the special case of a 0
cardinality, meaning a single value, does not allow arrays or vectors of
0 elements.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Return a default value or <code>null</code> if no default exists.</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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/osgi/service/metatype/MetaTypeInformation.html" title="interface in org.osgi.service.metatype"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/metatype/AttributeDefinition.html" target="_top"><B>FRAMES</B></A>
<A HREF="AttributeDefinition.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|