java/org/eclipse/lsp4j/DocumentHighlightKind.java

/******************************************************************************
 * Copyright (c) 2016 TypeFox and others.
 * 
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 * 
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 ******************************************************************************/
package org.eclipse.lsp4j;

/**
 * A document highlight kind.
 */
public enum DocumentHighlightKind {
	
	/**
	 * A textual occurrence.
	 */
	Text(1),
	
	/**
	 * Read-access of a symbol, like reading a variable.
	 */
	Read(2),
	
	/**
	 * Write-access of a symbol, like writing to a variable.
	 */
	Write(3);
	
	private final int value;
	
	DocumentHighlightKind(int value) {
		this.value = value;
	}
	
	public int getValue() {
		return value;
	}
	
	public static DocumentHighlightKind forValue(int value) {
		DocumentHighlightKind[] allValues = DocumentHighlightKind.values();
		if (value < 1 || value > allValues.length)
			throw new IllegalArgumentException("Illegal enum value: " + value);
		return allValues[value - 1];
	}

}