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.name.Name;
022    import org.jetbrains.kotlin.types.JetType;
023    
024    import java.util.Collection;
025    
026    public interface ValueParameterDescriptor extends VariableDescriptor, ParameterDescriptor {
027        @NotNull
028        @Override
029        CallableDescriptor getContainingDeclaration();
030    
031        /**
032         * Returns the 0-based index of the value parameter in the parameter list of its containing function.
033         *
034         * @return the parameter index
035         */
036        int getIndex();
037    
038        /**
039         * @return true iff this parameter belongs to a declared function (not a fake override) and declares the default value,
040         * i.e. explicitly specifies it in the function signature. Also see 'hasDefaultValue' extension in DescriptorUtils.kt
041         */
042        boolean declaresDefaultValue();
043    
044        @Nullable
045        JetType getVarargElementType();
046    
047        @NotNull
048        @Override
049        ValueParameterDescriptor getOriginal();
050    
051        @NotNull
052        ValueParameterDescriptor copy(@NotNull CallableDescriptor newOwner, @NotNull Name newName);
053    
054        /**
055         * Parameter p1 overrides p2 iff
056         * a) their respective owners (function declarations) f1 override f2
057         * b) p1 and p2 have the same indices in the owners' parameter lists
058         */
059        @NotNull
060        @Override
061        Collection<? extends ValueParameterDescriptor> getOverriddenDescriptors();
062    }