java/management/agent/src/main/java/org/apache/qpid/agent/binding/PropertyBinding.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.qpid.agent.binding;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.qpid.transport.codec.Encoder;

/**
 * Metadata for mapping a java property (getter/setter) to a QMF schema
 */
public class PropertyBinding
{
    private static Log log = LogFactory.getLog(PropertyBinding.class);
    public final static int READ_CREATE = 1;
    public final static int READ_WRITE = 2;
    public final static int READ_ONLY = 3;
    private String name;
    private TypeBinding type;
    private int accessType;
    private boolean optional;

    public PropertyBinding(String name, TypeBinding type, int accessType,
            boolean optional)
    {
        this.name = name;
        this.type = type;
        this.accessType = accessType;
        this.optional = optional;
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + accessType;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        result = prime * result + ((type == null) ? 0 : type.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        PropertyBinding other = (PropertyBinding) obj;
        if (accessType != other.accessType)
            return false;
        if (name == null)
        {
            if (other.name != null)
                return false;
        } else if (!name.equals(other.name))
            return false;
        if (type == null)
        {
            if (other.type != null)
                return false;
        } else if (!type.equals(other.type))
            return false;
        return true;
    }

    public String getName()
    {
        return name;
    }

    public TypeBinding getType()
    {
        return type;
    }

    public int getAccess()
    {
        return accessType;
    }

    public boolean isIndex()
    {
        return false;
    }

    public boolean isOptional()
    {
        return optional;
    }

    void encode(Encoder enc)
    {
        Map map = new HashMap();
        map.put("name", name);
        map.put("type", type.getCode());
        map.put("access", getAccess());
        map.put("index", isIndex() ? 1 : 0);
        map.put("optional", isOptional() ? 1 : 0);
        if (!type.isNative())
        {
            map.put("refClass", type.getRefClass());
            map.put("refPackage", type.getRefPackage());
        }
        enc.writeMap(map);
    }
}