/*
 * Copyright (c) 2002-2007 Sun Micro//Systems, Inc.  All rights reserved.
 *  
 *  The Sun Project JXTA(TM) Software License
 *  
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions are met:
 *  
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  
 *  2. Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation 
 *     and/or other materials provided with the distribution.
 *  
 *  3. The end-user documentation included with the redistribution, if any, must 
 *     include the following acknowledgment: "This product includes software 
 *     developed by Sun Microsystems, Inc. for JXTA(TM) technology." 
 *     Alternately, this acknowledgment may appear in the software itself, if 
 *     and wherever such third-party acknowledgments normally appear.
 *  
 *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must 
 *     not be used to endorse or promote products derived from this software 
 *     without prior written permission. For written permission, please contact 
 *     Project JXTA at http://www.jxta.org.
 *  
 *  5. Products derived from this software may not be called "JXTA", nor may 
 *     "JXTA" appear in their name, without prior written permission of Sun.
 *  
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
 *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN 
 *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United 
 *  States and other countries.
 *  
 *  Please see the license information page at :
 *  <http://www.jxta.org/project/www/license.html> for instructions on use of 
 *  the license in source files.
 *  
 *  ====================================================================
 *  
 *  This software consists of voluntary contributions made by many individuals 
 *  on behalf of Project JXTA. For more information on Project JXTA, please see 
 *  http://www.jxta.org.
 *  
 *  This license is based on the BSD license adopted by the Apache Foundation. 
 */
package net.jxta.impl.rendezvous.rpv;

import net.jxta.endpoint.EndpointAddress;
import net.jxta.id.ID;

/**
 * This class contains only the comparable portion of PeerViewElement, so that it is possible
 * to search for elements in the sorted set that the local PeerView is, without having
 * enough information to create a valid PeerViewElement.
 */
class PeerViewDestination implements Comparable<PeerViewDestination> {
    
    /**
     * The peer which is associated with this element.
     */
    private final ID peerid;
    
    /**
     * Constructs a PeerViewDestination from a (peer)ID.
     */
    PeerViewDestination(ID destination) {
        peerid = destination;
    }
    
    /**
     *  {@inheritDoc}
     */
    @Override
    public boolean equals(Object other) {
        return this == other || other instanceof PeerViewDestination && 0 == compareTo((PeerViewDestination) other);

    }
    
    /**
     *  {@inheritDoc}
     */
    @Override
    public int hashCode() {
        return peerid.hashCode();
    }
    
    /**
     * {@inheritDoc}
     * <p/>
     * Note that this compares the unique value of the id.
     */
    public int compareTo(PeerViewDestination pve) {
        String myUniqueValue = peerid.getUniqueValue().toString();
        String itsUniqueValue = pve.peerid.getUniqueValue().toString();

        return myUniqueValue.compareTo(itsUniqueValue);
    }

    /**
     *  Get the peer id of the peer associated with this connection.
     *
     *  @return    The peer id of the connected peer.
     */
    public ID getPeerID() {
        return peerid;
    }
    
    /**
     *  returns the destination address.
     *
     *  @return The endpoint address of the connected peer.
     */
    public EndpointAddress getDestAddress() {
        return new EndpointAddress(peerid, null, null);
    }
}