001    /*
002     * Copyright 2010-2015 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.kotlin.descriptors;
018    
019    import org.jetbrains.annotations.NotNull;
020    import org.jetbrains.annotations.Nullable;
021    import org.jetbrains.kotlin.resolve.constants.ConstantValue;
022    import org.jetbrains.kotlin.types.KotlinType;
023    import org.jetbrains.kotlin.types.TypeSubstitutor;
024    
025    public interface VariableDescriptor extends CallableDescriptor {
026        @NotNull
027        KotlinType getType();
028    
029        @Override
030        @NotNull
031        DeclarationDescriptor getContainingDeclaration();
032    
033        @Override
034        VariableDescriptor substitute(@NotNull TypeSubstitutor substitutor);
035    
036        boolean isVar();
037    
038        @Nullable
039        ConstantValue<?> getCompileTimeInitializer();
040    
041        /**
042         * @return true if iff original declaration has appropriate flags and type, e.g. `const` modifier in Kotlin.
043         * It completely does not means that if isConst then `getCompileTimeInitializer` is not null
044         */
045        boolean isConst();
046    }