RegExpSupport/src/org/intellij/lang/regexp/psi/RegExpChar.java

/*
 * Copyright 2006 Sascha Weinreuter
 *
 * 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.intellij.lang.regexp.psi;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Represents a simple or escaped character
 */
public interface RegExpChar extends RegExpAtom, RegExpClassElement, RegExpCharRange.Endpoint {
    /**
     * Character type enumeration. Represents either a plain character ("a"),
     * a hex encoded character value ("\x61"),
     * an octal encoded character value ("\0141"), or
     * a unicode escape character ("\u0061")
     */
    enum Type {
        CHAR, HEX, OCT, UNICODE, INVALID
    }

    /**
     * Returns the type of this character.
     * @see org.intellij.lang.regexp.psi.RegExpChar.Type
     */
    @NotNull
    Type getType();

    /**
     * Returns possibly unescaped character-value.
     * Null if escape sequence is invalid.
     */
    @Nullable
    Character getValue();
}