Crawler (microdocs-core-java 3.0.0 API)

java.lang.Object
- com.maxxton.microdocs.crawler.Crawler

Direct Known Subclasses:

SpringCrawler
```
public abstract class Crawler
extends java.lang.Object
```
Crawls classes and extract the project information

Constructor Summary

Constructors
Constructor Description

Crawler()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Project`	`crawl(java.util.List<ReflectClass<?>> classes, java.util.List<java.lang.String> customLibraries)`	Extract project information from the classes
`protected abstract Project`	`extractProject(ProjectBuilder projectBuilder, java.util.List<ReflectClass<?>> classes)`	Handles the extraction of the project information

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

- Constructor Detail
  - Crawler
```
public Crawler()
```
- Method Detail
  - crawl
```
public Project crawl(java.util.List<ReflectClass<?>> classes,
                     java.util.List<java.lang.String> customLibraries)
```
    Extract project information from the classes
    
    Parameters:
    
    classes - list of ReflectClasses
    
    customLibraries - simple list of references to libraries to make microdocs aware
    
    Returns:
    
    extracted project
  - extractProject
```
protected abstract Project extractProject(ProjectBuilder projectBuilder,
                                          java.util.List<ReflectClass<?>> classes)
```
    Handles the extraction of the project information
    
    Parameters:
    
    projectBuilder - builder of the project
    
    classes - list of ReflectClasses
    
    Returns:
    
    extracted project