org.biojava.nbio.structure.secstruc.BetaBridge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biojava-structure Show documentation

The protein structure modules of BioJava.

There is a newer version: 7.1.3

/*
 *                    BioJava development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  If you do not have a copy,
 * see:
 *
 *      http://www.gnu.org/copyleft/lesser.html
 *
 * Copyright for this code is held jointly by the individual
 * authors.  These should be listed in @author doc comments.
 *
 * For more information on the BioJava project and its aims,
 * or to join the biojava-l mailing list, visit the home page
 * at:
 *
 *      http://www.biojava.org/
 *
 */
package org.biojava.nbio.structure.secstruc;

import java.io.Serializable;

/**
 * Container that represents a beta Bridge between two residues. It contains the
 * two partner indices and the type of the bridge. For consistency, partner1 is
 * always the small index.
 *
 * @author Aleix Lafita
 *
 */
public class BetaBridge implements Serializable {

	private static final long serialVersionUID = -5097435425455958487L;

	BridgeType type;
	int partner1;
	int partner2;

	public BetaBridge(int i, int j, BridgeType t) {
		partner1 = Math.min(i, j);
		partner2 = Math.max(i, j);
		type = t;
	}

	@Override
		public int hashCode()
		{
			final int prime = 31;
			int result = 1;
			result = prime * result + getType().hashCode();
			result = prime * result + partner1;
			result = prime * result + partner2;
			return result;
		}

	@Override
	public boolean equals(Object o) {

		if (!(o instanceof BetaBridge))
			return false;

		BetaBridge b = (BetaBridge) o;
		if (type != b.type)
			return false;
		if (partner1 != b.partner1)
			return false;
		if (partner2 != b.partner2)
			return false;
		return true;
	}

	public BridgeType getType() {
		return type;
	}

	public int getPartner1() {
		return partner1;
	}

	public int getPartner2() {
		return partner2;
	}

}