• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2017 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 com.android.tools.metalava.model
18 
19 import com.android.tools.metalava.model.visitors.ItemVisitor
20 import com.android.tools.metalava.model.visitors.TypeVisitor
21 import java.util.function.Predicate
22 
23 /** Represents a Kotlin/Java source file */
24 interface SourceFileItem : Item {
25     /** Top level classes contained in this file */
classesnull26     fun classes(): Sequence<ClassItem>
27 
28     fun getHeaderComments(): String? = null
29 
30     fun getImportStatements(predicate: Predicate<Item>): Collection<Item> = emptyList()
31 
32     override fun parent(): PackageItem? = containingPackage()
33 
34     override fun containingClass(strict: Boolean): ClassItem? = null
35 
36     override fun type(): TypeItem? = null
37 
38     override fun accept(visitor: ItemVisitor) {
39         if (visitor.skip(this)) return
40 
41         visitor.visitItem(this)
42         visitor.visitSourceFile(this)
43 
44         classes().forEach { it.accept(visitor) }
45 
46         visitor.afterVisitSourceFile(this)
47         visitor.afterVisitItem(this)
48     }
49 
acceptTypesnull50     override fun acceptTypes(visitor: TypeVisitor) {
51         if (visitor.skip(this)) return
52 
53         classes().forEach { it.acceptTypes(visitor) }
54     }
55 }
56