FCQueryObj.java

/*
 * Copyright (c) 2013 Big Switch Networks, Inc.
 *
 * Licensed under the Eclipse Public License, Version 1.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.eclipse.org/legal/epl-v10.html
 *
 * 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.sdnplatform.flowcache;

import java.util.Arrays;

import org.sdnplatform.devicemanager.IDevice;
import org.sdnplatform.flowcache.IFlowCacheService.FCQueryEvType;



/**
 * The Class FCQueryObj.
 */
public class FCQueryObj {

    /** The caller of the flow cache query. */
    public IFlowQueryHandler fcQueryHandler;
    /** The application instance name. */
    public String applInstName;
    /** The vlan Id. */
    public Short[] vlans;
    /** The destination device. */
    public IDevice dstDevice;
    /** The source device. */
    public IDevice srcDevice;
    /** The caller name */
    public String callerName;
    /** Event type that triggered this flow query submission */
    public FCQueryEvType evType;
    /** The caller opaque data. Returned unchanged in the query response
     * via the callback. The type of this object could be different for
     * different callers */
    public Object callerOpaqueObj;

    /**
     * Instantiates a new flow cache query object
     */
    public FCQueryObj(IFlowQueryHandler fcQueryHandler,
            String        applInstName,
            Short         vlan,
            IDevice       srcDevice,
            IDevice       dstDevice,
            String        callerName,
            FCQueryEvType evType,
            Object        callerOpaqueObj) {
        this.fcQueryHandler    = fcQueryHandler;
        this.applInstName     = applInstName;
        this.srcDevice        = srcDevice;
        this.dstDevice        = dstDevice;
        this.callerName       = callerName;
        this.evType           = evType;
        this.callerOpaqueObj  = callerOpaqueObj;
        
        if (vlan != null) {
        	this.vlans = new Short[] { vlan };
        } else {
            this.vlans = null;
        }
    }

    @Override
    public String toString() {
        return "FCQueryObj [fcQueryCaller=" + fcQueryHandler
                + ", applInstName="
                + applInstName + ", vlans=" + Arrays.toString(vlans)
                + ", dstDevice=" + dstDevice + ", srcDevice="
                + srcDevice + ", callerName=" + callerName + ", evType="
                + evType + ", callerOpaqueObj=" + callerOpaqueObj + "]";
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result
                 + ((applInstName == null) ? 0 : applInstName.hashCode());
        result = prime * result
                 + ((callerName == null) ? 0 : callerName.hashCode());
        result = prime
                 * result
                 + ((callerOpaqueObj == null) ? 0
                                             : callerOpaqueObj.hashCode());
        result = prime * result
                 + ((dstDevice == null) ? 0 : dstDevice.hashCode());
        result = prime * result + ((evType == null) ? 0 : evType.hashCode());
        result = prime
                 * result
                 + ((fcQueryHandler == null) ? 0 : fcQueryHandler.hashCode());
        result = prime * result
                 + ((srcDevice == null) ? 0 : srcDevice.hashCode());
        result = prime * result + Arrays.hashCode(vlans);
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        FCQueryObj other = (FCQueryObj) obj;
        if (applInstName == null) {
            if (other.applInstName != null) return false;
        } else if (!applInstName.equals(other.applInstName)) return false;
        if (callerName == null) {
            if (other.callerName != null) return false;
        } else if (!callerName.equals(other.callerName)) return false;
        if (callerOpaqueObj == null) {
            if (other.callerOpaqueObj != null) return false;
        } else if (!callerOpaqueObj.equals(other.callerOpaqueObj))
                                                                  return false;
        if (dstDevice == null) {
            if (other.dstDevice != null) return false;
        } else if (!dstDevice.equals(other.dstDevice)) return false;
        if (evType != other.evType) return false;
        if (fcQueryHandler == null) {
            if (other.fcQueryHandler != null) return false;
        } else if (!fcQueryHandler.equals(other.fcQueryHandler))
                                                                return false;
        if (srcDevice == null) {
            if (other.srcDevice != null) return false;
        } else if (!srcDevice.equals(other.srcDevice)) return false;
        if (!Arrays.equals(vlans, other.vlans)) return false;
        return true;
    }
    
    
}