/* ###
 * IP: GHIDRA
 *
 * 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 ghidra.app.plugin.core.symboltree.nodes;

import java.util.Objects;

import ghidra.program.model.listing.Program;
import ghidra.program.model.symbol.Symbol;

/**
 * A special version of {@link SymbolNode} that is used as a key when searching for other 
 * symbol nodes.  This class allows us to search for another symbol node using whatever 
 * name is desired.
 */
public class SearchKeySymbolNode extends SymbolNode {

	private String searchName;

	SearchKeySymbolNode(Program program, Symbol symbol, String searchName) {
		super(program, symbol);
		Objects.requireNonNull(searchName);
		this.searchName = getNameFromBaseName(searchName);
	}

	@Override
	public String getName() {
		return searchName;
	}
}
