sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/id/jxta/IDFormat.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.id.jxta;
  58
  59
  60 import net.jxta.id.IDFactory;
  61
  62
  63 /**
  64  * The 'jxta' ID Format is used for the presentation of a limited number of
  65  * well-known ids. These are the null id, the world peer group id, and the
  66  * default net peer group id. JXTA depends on being able to refer to these
  67  * standard entities in a common way regardless of what other id formats are
  68  * used, indeed this ID Format and these ids exist so that there are not a
  69  * different representations for the ids of these entities with each ID Format.
  70  *
  71  * <p/>Rather than return its own version of these well known IDs, each ID
  72  * Format <b>MUST</b> return these IDs as appropriate.
  73  *
  74  * <ul>
  75  * <li>the null id - the NullID is often used as a placeholder in fields which
  76  * are uninitialized.</li>
  77  *
  78  * <li>the world peer group id - the id of the world peer group.</li>
  79  *
  80  * <li>the default net peer group id - the id of the default net peer group.</li>
  81  * </ul>
  82  *
  83  * @see net.jxta.id.ID
  84  * @see net.jxta.id.IDFactory
  85  @see <a href="http://spec.jxta.org/nonav/v1.0/docbook/JXTAProtocols.html#ids" target='_blank'>JXTA Protocols Specification : IDs</a>
  86  @see <a href="http://spec.jxta.org/nonav/v1.0/docbook/JXTAProtocols.html#ids-jinf" target='_blank'>JXTA Protocols Specification : ?jxta? ID Format</a>
  87  *
  88  **/
  89 public final class IDFormat {
  90
  91     /**
  92      * The name associated with this ID Format.
  93      */
  94     final static String JXTAFormat = "jxta";
  95
  96     /**
  97      * The instantiator for this ID Format which is used by the IDFactory.
  98      *
  99      * @since JXTA 1.0
 100      **/
 101     public static final IDFactory.URIInstantiator INSTANTIATOR = new Instantiator();
 102
 103     /**
 104      *  Private Constructor. This class cannot be instantiated.
 105      **/
 106     private IDFormat() {}
 107 }