hr.fer.zemris.vhdllab.service.ci.CircuitInterface.java Source code

Introduction

Here is the source code for hr.fer.zemris.vhdllab.service.ci.CircuitInterface.java

Source

/*******************************************************************************
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership.
 * 
 * Licensed 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 hr.fer.zemris.vhdllab.service.ci;

import static org.apache.commons.lang.StringUtils.lowerCase;
import hr.fer.zemris.vhdllab.validation.NameFormatConstraint;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.Validate;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.hibernate.validator.Length;
import org.hibernate.validator.NotEmpty;
import org.hibernate.validator.NotNull;
import org.hibernate.validator.Size;
import org.hibernate.validator.Valid;

/**
 * Describes an <code>ENTITY</code> block of VHDL code.
 * 
 * @author Miro Bezjak
 * @version 1.0
 * @since vhdllab2
 */
public class CircuitInterface implements Serializable {

    private static final long serialVersionUID = -7941833394453145492L;

    @NotEmpty
    @Length(max = 255)
    @NameFormatConstraint
    private String name;
    @NotNull
    @Size(max = 30)
    @Valid
    private List<Port> ports;

    public CircuitInterface() {
        this(null, null);
    }

    public CircuitInterface(String name) {
        this(name, null);
    }

    public CircuitInterface(String name, Port port) {
        setName(name);
        ports = new ArrayList<Port>();
        if (port != null) {
            add(port);
        }
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public boolean isName(String circuitName) {
        return StringUtils.equalsIgnoreCase(this.name, circuitName);
    }

    public void addAll(List<Port> collection) {
        ports.addAll(collection);
    }

    public void add(Port port) {
        ports.add(port);
    }

    public Port getPort(String portName) {
        Validate.notNull(portName, "Port name can't be null");
        for (Port p : ports) {
            if (StringUtils.equalsIgnoreCase(p.getName(), portName)) {
                return p;
            }
        }
        return null;
    }

    public List<Port> getPorts() {
        return ports;
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(lowerCase(name)).append(ports).toHashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (!(obj instanceof CircuitInterface))
            return false;
        CircuitInterface other = (CircuitInterface) obj;
        return new EqualsBuilder().append(lowerCase(name), lowerCase(other.name)).append(ports, other.ports)
                .isEquals();
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder(10 + ports.size() * 50);
        sb.append("ENTITY ").append(name).append(" IS");
        if (!ports.isEmpty()) {
            sb.append(" PORT(\n");
            for (Port p : ports) {
                sb.append("\t").append(p).append(";\n");
            }
            // remove last semi-colon
            sb.delete(sb.length() - 2, sb.length() - 1);
            sb.append(");");
        }
        sb.append("\nEND ").append(name).append(";");
        return sb.toString();
    }

}