/*******************************************************************************
*   Copyright 2015 Analog Devices, Inc.
*
*   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.analog.lyric.dimple.model.values;

import com.analog.lyric.dimple.model.domains.FiniteFieldNumber;

import net.jcip.annotations.Immutable;

/**
 * Immutable value containing a {@link FiniteFieldNumber}.
 * <p>
 * @since 0.08
 * @author Christopher Barber
 */
@Immutable
public final class ConstantFiniteFieldValue extends FiniteFieldValue
{
	private static final long serialVersionUID = 1L;

	/*--------------
	 * Construction
	 */
	
	public ConstantFiniteFieldValue(FiniteFieldNumber number)
	{
		super(number);
	}
	
	@Override
	public DiscreteValue immutableClone()
	{
		return this;
	}
	
	@Override
	public DiscreteValue mutableClone()
	{
		return new FiniteFieldValue(getFiniteField());
	}

	/*---------------
	 * Value methods
	 */
	
	@Override
	public boolean isMutable()
	{
		return false;
	}
	
	@Override
	public void setFiniteField(FiniteFieldNumber value)
	{
		throw notMutable();
	}
}