ApiSurface (Google Cloud Dataflow SDK 1.0.0 API)

java.lang.Object
- com.google.cloud.dataflow.sdk.util.ApiSurface

```
public class ApiSurface
extends Object
```
Represents the API surface of a package prefix. Used for accessing public classes, methods, and the types they reference, to control what dependencies are re-exported.
For the purposes of calculating the public API surface, exposure includes any public or protected occurrence of:
- superclasses
- interfaces implemented
- actual type arguments to generic types
- array component types
- method return types
- method parameter types
- type variable bounds
- wildcard bounds
Exposure is a transitive property. The resulting map excludes primitives and array classes themselves.
It is prudent (though not required) to prune prefixes like "java" via the builder method pruningPrefix(java.lang.String) to halt the traversal so it does not uselessly catalog references that are not interesting.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ApiSurface`	`empty()` Returns an empty `ApiSurface`.
`List<Class<?>>`	`getAnyExposurePath(Class<?> exposedClass)` Returns a path from an exposed class to a root class.
`Set<Class<?>>`	`getExposedClasses()` Returns exposed types in this set, including arrays and primitives as specified.
`Set<Class<?>>`	`getRootClasses()` Returns all public classes originally belonging to the package in the `ApiSurface`.
`static ApiSurface`	`getSdkApiSurface()`
`ApiSurface`	`includingClass(Class<?> clazz)` Returns an `ApiSurface` like this one, but also including the given class.
`ApiSurface`	`includingPackage(String packageName)` Returns an `ApiSurface` like this one, but also including the named package and all of its subpackages.
`static void`	`main(String[] args)`
`static ApiSurface`	`ofClass(Class<?> clazz)` Returns an `ApiSurface` object representing just the surface of the given class.
`static ApiSurface`	`ofPackage(String packageName)` Returns an `ApiSurface` object representing the given package and all subpackages.
`ApiSurface`	`pruningClass(Class<?> clazz)` Returns an `ApiSurface` like this one, but pruning references from the provided class.
`ApiSurface`	`pruningClassName(String className)` Returns an `ApiSurface` like this one, but pruning references from the named class.
`ApiSurface`	`pruningPattern(Pattern pattern)` Returns an `ApiSurface` like this one, but pruning transitive references from classes whose full name (including package) begins with the provided prefix.
`ApiSurface`	`pruningPattern(String patternString)` See {@link #pruningPattern(Pattern).
`ApiSurface`	`pruningPrefix(String prefix)` Returns an `ApiSurface` like this one, but pruning transitive references from classes whose full name (including package) begins with the provided prefix.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - empty
```
public static ApiSurface empty()
```
    Returns an empty ApiSurface.
  - ofPackage
```
public static ApiSurface ofPackage(String packageName)
                            throws IOException
```
    Returns an ApiSurface object representing the given package and all subpackages.
    
    Throws:
    
    IOException
  - ofClass
```
public static ApiSurface ofClass(Class<?> clazz)
```
    Returns an ApiSurface object representing just the surface of the given class.
  - includingPackage
```
public ApiSurface includingPackage(String packageName)
                            throws IOException
```
    Returns an ApiSurface like this one, but also including the named package and all of its subpackages.
    
    Throws:
    
    IOException
  - includingClass
```
public ApiSurface includingClass(Class<?> clazz)
```
    Returns an ApiSurface like this one, but also including the given class.
  - pruningPrefix
```
public ApiSurface pruningPrefix(String prefix)
```
    Returns an ApiSurface like this one, but pruning transitive references from classes whose full name (including package) begins with the provided prefix.
  - pruningClassName
```
public ApiSurface pruningClassName(String className)
```
    Returns an ApiSurface like this one, but pruning references from the named class.
  - pruningClass
```
public ApiSurface pruningClass(Class<?> clazz)
```
    Returns an ApiSurface like this one, but pruning references from the provided class.
  - pruningPattern
```
public ApiSurface pruningPattern(Pattern pattern)
```
    Returns an ApiSurface like this one, but pruning transitive references from classes whose full name (including package) begins with the provided prefix.
  - pruningPattern
```
public ApiSurface pruningPattern(String patternString)
```
    See {@link #pruningPattern(Pattern).
  - getRootClasses
```
public Set<Class<?>> getRootClasses()
```
    Returns all public classes originally belonging to the package in the ApiSurface.
  - getExposedClasses
```
public Set<Class<?>> getExposedClasses()
```
    Returns exposed types in this set, including arrays and primitives as specified.
  - getAnyExposurePath
```
public List<Class<?>> getAnyExposurePath(Class<?> exposedClass)
```
    Returns a path from an exposed class to a root class. There may be many, but this gives only one.
    If there are only cycles, with no path back to a root class, throws IllegalStateException.
  - getSdkApiSurface
```
public static ApiSurface getSdkApiSurface()
                                   throws IOException
```
    Throws:
    
    IOException
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class ApiSurface

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

ofPackage

ofClass

includingPackage

includingClass

pruningPrefix

pruningClassName

pruningClass

pruningPattern

pruningPattern

getRootClasses

getExposedClasses

getAnyExposurePath

getSdkApiSurface

main