/*
 * Copyright 2004-2010 the Seasar Foundation and the Others.
 *
 * 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 org.seasar.cubby.action;

/**
 * HTML フォーム中のフィールドを表します。
 * 
 * @author baba
 */
public class FieldInfo {

	/** フィールド名。 */
	private final String name;

	/** インデックス。 */
	private final Integer index;

	/**
	 * 指定されたフィールド名のフィールドの情報をインスタンス化します。
	 * 
	 * @param name
	 *            フィールド名
	 */
	public FieldInfo(final String name) {
		this(name, null);
	}

	/**
	 * 指定されたフィールド名とインデックスのフィールドの情報をインスタンス化します。
	 * 
	 * @param name
	 *            フィールド名
	 * @param index
	 *            インデックス
	 */
	public FieldInfo(final String name, final Integer index) {
		this.name = name;
		this.index = index;
	}

	/**
	 * フィールド名を取得します。
	 * 
	 * @return フィールド名
	 */
	public String getName() {
		return name;
	}

	/**
	 * インデックスを取得します。
	 * <p>
	 * コンストラクタでインデックスを指定しなかった場合は <code>null</code> を返します。
	 * </p>
	 * 
	 * @return インデックス
	 */
	public Integer getIndex() {
		return index;
	}

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		final FieldInfo other = (FieldInfo) obj;
		if (index == null) {
			if (other.index != null) {
				return false;
			}
		} else if (!index.equals(other.index)) {
			return false;
		}
		if (name == null) {
			if (other.name != null) {
				return false;
			}
		} else if (!name.equals(other.name)) {
			return false;
		}
		return true;
	}

}
