com.anrisoftware.sscontrol.firewall.statements.Address.java Source code

Introduction

Here is the source code for com.anrisoftware.sscontrol.firewall.statements.Address.java

Source

/*
 * Copyright 2012-2015 Erwin Mller <erwin.mueller@deventm.org>
 *
 * This file is part of sscontrol-firewall.
 *
 * sscontrol-firewall is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * sscontrol-firewall is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with sscontrol-firewall. If not, see <http://www.gnu.org/licenses/>.
 */
package com.anrisoftware.sscontrol.firewall.statements;

import java.io.Serializable;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;

import com.google.inject.assistedinject.Assisted;
import com.google.inject.assistedinject.AssistedInject;

/**
 * Network address, either a IP address or host name, or any (anywhere).
 * 
 * @author Erwin Mueller, erwin.mueller@deventm.org
 * @since 1.0
 */
@SuppressWarnings("serial")
public class Address implements Serializable {

    private static final String ANY = "any";
    private static final String ADDRESS = "address";

    private final String address;

    /**
     * @see AddressFactory#anyAddress()
     */
    @AssistedInject
    Address() {
        this.address = null;
    }

    /**
     * @see AddressFactory#fromAddress(String)
     */
    @AssistedInject
    Address(@Assisted String address) {
        this.address = address;
    }

    /**
     * Returns true if this address is a placeholder for anywhere.
     */
    public boolean isAnywhere() {
        return address == null;
    }

    public String getName() {
        return address;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (obj == this) {
            return true;
        }
        if (obj.getClass() != getClass()) {
            return false;
        }
        Address rhs = (Address) obj;
        return new EqualsBuilder().append(address, rhs.address).isEquals();
    }

    @Override
    public String toString() {
        ToStringBuilder builder = new ToStringBuilder(this);
        if (address != null) {
            builder.append(ADDRESS, address);
        } else {
            builder.append(ANY);
        }
        return builder.toString();
    }
}