ServerIdWrapper.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.studio.openldap.config.editor.wrappers;

import org.apache.directory.api.util.Strings;

/**
 * A wrapper for a ServerID which can be either an integer between 0 and 4095 
 * (or from 0x0 to 0xFFF), and may be followed by an URL. We can't have both format,
 * and if it's not an URL, then only one value is accepted. The syntax is :
 * <pre>
 * ServerId ::= ( INT | HEX ) [ ' ' URL ]
 * </pre> 
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class ServerIdWrapper implements Cloneable, Comparable<ServerIdWrapper>
{
    /** The server ID */
    private int serverId;
    
    /** The URL, if any */
    private String url;

    /**
     * Creates a new instance of ServerIdWrapper.
     */
    public ServerIdWrapper()
    {
    }

    /**
     * Creates a new instance of ServerIdWrapper.
     *
     * @param serverId the serverID
     */
    public ServerIdWrapper( int serverId )
    {
        this.serverId = serverId;
    }

    
    /**
     * Creates a new instance of ServerIdWrapper.
     *
     * @param serverId the serverID
     * @param url the URL
     */
    public ServerIdWrapper( int serverId, String url )
    {
        this.serverId = serverId;
        this.url = url;
    }

    
    /**
     * Parse a String that contains either a integer value or an hexa value
     */
    private int parseInt( String str )
    {
        if ( str.startsWith( "0x" ) || str.startsWith( "0X" ) )
        {
            return Integer.parseInt( str.substring( 2 ), 16 );
        }
        else
        {
            return Integer.parseInt( str );
        }
    }
    
    /**
     * Creates a new instance of ServerIdWrapper.
     *
     * @param serverIdStr the serverID
     */
    public ServerIdWrapper( String serverIdStr )
    {
        if ( !Strings.isEmpty( serverIdStr ) )
        {
            // Let's see if we have an URL, and if so, it's after the number 
            int pos = serverIdStr.indexOf( ' ' );
            
            if ( pos == -1 )
            {
                // No URL
                serverId = parseInt( serverIdStr );
            }
            else
            {
                // ServerID and URL
                this.serverId = parseInt( serverIdStr.substring( 0, pos ) );
                this.url = serverIdStr.substring( pos + 1 );
            }
        }
    }

    
    /**
     * @return the serverId
     */
    public int getServerId()
    {
        return serverId;
    }

    /**
     * @param serverId the serverId to set
     */
    public void setServerId( int serverId )
    {
        this.serverId = serverId;
    }
    
    
    /**
     * @return the url
     */
    public String getUrl()
    {
        return url;
    }

    /**
     * @param url the url to set
     */
    public void setUrl( String url )
    {
        this.url = url;
    }
    
    
    /**
     * Clone the current object
     */
    public ServerIdWrapper clone()
    {
        try
        {
            return (ServerIdWrapper)super.clone();
        }
        catch ( CloneNotSupportedException e )
        {
            return null;
        }
    }

    
    /**
     * @see Object#equals(Object)
     */
    public boolean equals( Object that )
    {
        // Quick test
        if ( this == that )
        {
            return true;
        }
        
        if ( that instanceof ServerIdWrapper )
        {
            ServerIdWrapper thatInstance = (ServerIdWrapper)that;
            
            if ( serverId != thatInstance.serverId )
            {
                return false;
            }
            
            if ( url == thatInstance.url )
            {
                return true;
            }
            
            if ( url != null )
            {
                return url.equals( thatInstance.url );
            }
            else
            {
                return thatInstance.url == null;
            }
        }
        else
        {
            return false;
        }
    }

    
    /**
     * @see Object#hashCode()
     */
    public int hashCode()
    {
        int h = 37;
        
        h += h*17 + serverId;
        
        if ( url != null )
        {
            h += h*17 + url.hashCode();
        }
        
        return h;
    }


    /**
     * @see Comparable#compareTo()
     */
    public int compareTo( ServerIdWrapper that )
    {
        if ( that == null )
        {
            return 1;
        }
        
        // Check the serverId first
        if ( serverId == that.serverId )
        {
            // Now, compare the url
            if ( Strings.isEmpty( url ) )
            {
                return 0;
            }
            else
            {
                return url.compareToIgnoreCase( that.url );
            }
        }
        else
        {
            return serverId - that.serverId;
        }
    }
    
    
    /**
     * @see Object#toString()
     */
    public String toString()
    {
        if ( url == null )
        {
            return Integer.toString( serverId );
        }
        else
        {
            return Integer.toString( serverId ) + " " + url;
        }
    }
}