com.googlecode.fightinglayoutbugs.helpers.RectangularRegion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fighting-layout-bugs Show documentation
A library for automatic detection of layout bugs in web pages
The newest version!
/*
 * Copyright 2009-2012 Michael Tamm
 *
 * 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 com.googlecode.fightinglayoutbugs.helpers;

import java.awt.Rectangle;
import java.io.Serializable;

public final class RectangularRegion implements Serializable {

    private static final long serialVersionUID = 1L;

    /** X coordinate of top left corner (inclusive -- belongs to this rectangular region). */
    public final int x1;
    /** Y coordinate of top left corner (inclusive -- belongs to this rectangular region). */
    public final int y1;
    /** X coordinate of bottom right corner (inclusive -- belongs to this rectangular region). */
    public final int x2;
    /** Y coordinate of bottom right corner (inclusive -- belongs to this rectangular region). */
    public final int y2;

    /**
     * Constructs a rectangular region covering all
     * pixels from the top left corner (x1,x2)
     * to the bottom right corner (x2,y2).
     */
    public RectangularRegion(int x1, int y1, int x2, int y2) {
        if (x1 < 0) {
            throw new IllegalArgumentException("x1 (" + x1 + ") must not be negative.");
        }
        if (y1 < 0) {
            throw new IllegalArgumentException("y1 (" + y1 + ") must not be negative.");
        }
        if (x2 < x1) {
            throw new IllegalArgumentException("x2 (" + x2 + ") must not be less than x1 (" + x1 + ").");
        }
        if (y2 < y1) {
            throw new IllegalArgumentException("y2 (" + y2 + ") must not be less than y1 (" + y1 + ").");
        }
        this.x1 = x1;
        this.y1 = y1;
        this.x2 = x2;
        this.y2 = y2;
    }

    @Override
    public int hashCode() {
        return (x1 << 16 | x2) ^ (y1 << 16 | y2);
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        } else if (o instanceof RectangularRegion) {
            RectangularRegion other = (RectangularRegion) o;
            return (this.x1 == other.x1 && this.x2 == other.x2 && this.y1 == other.y1 && this.y2 == other.y2);
        } else {
            return false;
        }
    }

    @Override
    public String toString() {
        return "(" + x1 + "," + y1 + ") - (" + x2 + "," + y2 + ")";
    }

    public Rectangle asRectangle() {
        return new Rectangle(x1, y1, (x2 - x1) + 1, (y2 - y1) + 1);
    }
}