30b60752ab624d1da9d520f7e2ec28728cfd0bb3
[idea/community.git] / java / java-psi-api / src / com / intellij / psi / PsiField.java
1 /*
2  * Copyright 2000-2017 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.psi;
17
18 import com.intellij.lang.jvm.JvmField;
19 import com.intellij.lang.jvm.types.JvmType;
20 import com.intellij.util.ArrayFactory;
21 import com.intellij.util.IncorrectOperationException;
22 import org.jetbrains.annotations.NotNull;
23 import org.jetbrains.annotations.Nullable;
24
25 import static com.intellij.psi.PsiJvmConversionHelper.toJvmType;
26
27 /**
28  * Represents a Java field or enum constant.
29  */
30 public interface PsiField extends PsiMember, PsiVariable, PsiDocCommentOwner, JvmField {
31   /**
32    * The empty array of PSI fields which can be reused to avoid unnecessary allocations.
33    */
34   PsiField[] EMPTY_ARRAY = new PsiField[0];
35
36   ArrayFactory<PsiField> ARRAY_FACTORY = count -> count == 0 ? EMPTY_ARRAY : new PsiField[count];
37
38   /**
39    * Adds initializer to the field declaration or, if {@code initializer} parameter is null,
40    * removes the initializer from the field declaration.
41    *
42    * @param initializer the initializer to add.
43    * @throws IncorrectOperationException if the modifications fails for some reason.
44    * @since 5.0.2
45    */
46   void setInitializer(@Nullable PsiExpression initializer) throws IncorrectOperationException;
47
48   @Override
49   @NotNull PsiIdentifier getNameIdentifier();
50
51   @Nullable
52   @Override
53   default PsiField getPsiElement() {
54     return this;
55   }
56
57   @NotNull
58   @Override
59   default JvmType fieldType() {
60     return toJvmType(getType());
61   }
62 }