1 /* 2 * Copyright (C) 2009 The Android Open Source Project 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 17 package signature.model; 18 19 import signature.converter.Visibility; 20 21 import java.util.Set; 22 23 /** 24 * {@code IApi} models the root of an api. 25 */ 26 public interface IApi { 27 /** 28 * Returns the name of this api. 29 * 30 * @return the name of this api 31 */ getName()32 String getName(); 33 34 /** 35 * Sets the name of this api. 36 * 37 * @param name 38 * the name of this api 39 */ setName(String name)40 void setName(String name); 41 42 /** 43 * Returns the set of packages which constitute this api. 44 * 45 * @return the set of packages which constitute this api 46 */ getPackages()47 Set<IPackage> getPackages(); 48 49 /** 50 * Returns the visibility of this api. The visibility describes which 51 * elements are visible. Only elements with a visibility greater or equal 52 * this visibility are contained in this api model. 53 * 54 * @return the visibility of this api 55 * @see Visibility 56 */ getVisibility()57 Visibility getVisibility(); 58 } 59