AmbiguousIdException.java

/*
 * sulky-modules - several general-purpose modules.
 * Copyright (C) 2007-2011 Joern Huxhorn
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Copyright 2007-2011 Joern Huxhorn
 *
 * 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 de.huxhorn.sulky.blobs;

import java.util.Arrays;

/**
 * This exception is thrown by BlobRepository implementations if an id used to reference a blob could reference more than
 * one blob.
 */
public class AmbiguousIdException
	extends Exception
{
	private final String id;
	private final String[] candidates;

	public AmbiguousIdException(String id, String[] candidates)
	{
		super("The id '"+id+"' does not uniquely identify a blob. Candidates are: "+ Arrays.toString(candidates));
		this.id = id;
		if(candidates == null)
		{
			throw new IllegalArgumentException("candidates must not be null!");
		}
		this.candidates = new String[candidates.length];
		System.arraycopy(candidates, 0, this.candidates, 0, candidates.length);
	}

	/**
	 * Returns the id that caused this exception.
	 *
	 * @return the id that caused this exception.
	 */
	public String getId()
	{
		return id;
	}

	/**
	 * Returns the ids of possible blob candidates.
	 *
	 * @return the ids of possible blob candidates.
	 */
	public String[] getCandidates()
	{
		String[] result=new String[this.candidates.length];
		System.arraycopy(this.candidates, 0, result, 0, this.candidates.length);
		return result;
	}
}