001    /*
002     * Copyright 2010-2013 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.jet.lang.descriptors;
018    
019    import org.jetbrains.annotations.NotNull;
020    
021    public abstract class Visibility {
022        private final boolean isPublicAPI;
023        private final String name;
024    
025        protected Visibility(@NotNull String name, boolean isPublicAPI) {
026            this.isPublicAPI = isPublicAPI;
027            this.name = name;
028        }
029    
030        public boolean isPublicAPI() {
031            return isPublicAPI;
032        }
033    
034        /**
035        * @return null if the answer is unknown
036        */
037        protected Integer compareTo(@NotNull Visibility visibility) {
038            return Visibilities.compareLocal(this, visibility);
039        }
040    
041        @Override
042        public String toString() {
043            return name;
044        }
045    
046        @NotNull
047        public Visibility normalize() {
048            return this;
049        }
050    
051        protected abstract boolean isVisible(@NotNull DeclarationDescriptorWithVisibility what, @NotNull DeclarationDescriptor from);
052    }