sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/peer/PeerID.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.peer;
  58
  59
  60 import java.net.URI;
  61 import net.jxta.id.ID;
  62
  63
  64 /**
  65  *  This class implements a PeerID. Each peer is assigned a unique peer id.
  66  *
  67  *  @see net.jxta.id.ID
  68  *  @see net.jxta.id.IDFactory
  69  *  @see net.jxta.peergroup.PeerGroupID
  70  */
  71 public abstract class PeerID extends ID {
  72
  73     /**
  74      * Creates an ID by parsing the given URI.
  75      *
  76      * <p>This convenience factory method works as if by invoking the
  77      * {@link net.jxta.id.IDFactory#fromURI(URI)} method; any
  78      * {@link java.net.URISyntaxException} thrown is caught and wrapped in a
  79      * new {@link IllegalArgumentException} object, which is then thrown.
  80      *
  81      * <p> This method is provided for use in situations where it is known that
  82      * the given string is a legal ID, for example for ID constants declared
  83      * within in a program, and so it would be considered a programming error
  84      * for the URI not to parse as such.  The {@link net.jxta.id.IDFactory},
  85      * which throws {@link java.net.URISyntaxException} directly, should be used
  86      * situations where a ID is being constructed from user input or from some
  87      * other source that may be prone to errors.
  88      *
  89      * @param  fromURI   The URI to be parsed into an ID
  90      * @return The new ID
  91      *
  92      * @throws  NullPointerException If {@code fromURI} is {@code null}.
  93      * @throws  IllegalArgumentException If the given URI is not a valid ID.
  94      */
  95     public static PeerID create(URI fromURI) {
  96         return (PeerID) ID.create(fromURI);
  97     }
  98
  99     /**
 100      *  {@inheritDoc}
 101      */
 102     public PeerID intern() {
 103         return (PeerID) super.intern();
 104     }
 105
 106     /**
 107      *  Returns PeerGroupID of the Peer Group to which this Peer ID belongs.
 108      *
 109      *  @return PeerGroupID of the Peer Group to which this Peer ID belongs.
 110      */
 111     public abstract ID getPeerGroupID();
 112 }