xref: /aosp_15_r20/external/doclava/src/com/google/doclava/Linter.java (revision feeed43c7c55e85932c547a3cefc559df175227c)
1*feeed43cSAndroid Build Coastguard Worker /*
2*feeed43cSAndroid Build Coastguard Worker  * Copyright (C) 2017 Google Inc.
3*feeed43cSAndroid Build Coastguard Worker  *
4*feeed43cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*feeed43cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*feeed43cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*feeed43cSAndroid Build Coastguard Worker  *
8*feeed43cSAndroid Build Coastguard Worker  * http://www.apache.org/licenses/LICENSE-2.0
9*feeed43cSAndroid Build Coastguard Worker  *
10*feeed43cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*feeed43cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*feeed43cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*feeed43cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*feeed43cSAndroid Build Coastguard Worker  * limitations under the License.
15*feeed43cSAndroid Build Coastguard Worker  */
16*feeed43cSAndroid Build Coastguard Worker 
17*feeed43cSAndroid Build Coastguard Worker package com.google.doclava;
18*feeed43cSAndroid Build Coastguard Worker 
19*feeed43cSAndroid Build Coastguard Worker public interface Linter {
lintField(FieldInfo field)20*feeed43cSAndroid Build Coastguard Worker   public void lintField(FieldInfo field);
lintMethod(MethodInfo method)21*feeed43cSAndroid Build Coastguard Worker   public void lintMethod(MethodInfo method);
lintParameter(MethodInfo method, ParameterInfo param, SourcePositionInfo position, TagInfo tag)22*feeed43cSAndroid Build Coastguard Worker   public void lintParameter(MethodInfo method, ParameterInfo param, SourcePositionInfo position,
23*feeed43cSAndroid Build Coastguard Worker       TagInfo tag);
24*feeed43cSAndroid Build Coastguard Worker }
25*feeed43cSAndroid Build Coastguard Worker 
26*feeed43cSAndroid Build Coastguard Worker class EmptyLinter implements Linter {
27*feeed43cSAndroid Build Coastguard Worker   @Override
lintField(FieldInfo field)28*feeed43cSAndroid Build Coastguard Worker   public void lintField(FieldInfo field) {
29*feeed43cSAndroid Build Coastguard Worker   }
30*feeed43cSAndroid Build Coastguard Worker 
31*feeed43cSAndroid Build Coastguard Worker   @Override
lintMethod(MethodInfo method)32*feeed43cSAndroid Build Coastguard Worker   public void lintMethod(MethodInfo method) {
33*feeed43cSAndroid Build Coastguard Worker   }
34*feeed43cSAndroid Build Coastguard Worker 
35*feeed43cSAndroid Build Coastguard Worker   @Override
lintParameter(MethodInfo method, ParameterInfo param, SourcePositionInfo position, TagInfo tag)36*feeed43cSAndroid Build Coastguard Worker   public void lintParameter(MethodInfo method, ParameterInfo param, SourcePositionInfo position,
37*feeed43cSAndroid Build Coastguard Worker       TagInfo tag) {
38*feeed43cSAndroid Build Coastguard Worker   }
39*feeed43cSAndroid Build Coastguard Worker }
40