GenericExporter (Querydsl 5.0.0 API)

java.lang.Object
- com.querydsl.codegen.GenericExporter

public class GenericExporter
extends java.lang.Object

GenericExporter provides query type serialization logic for cases where APT annotation processors can't be used. GenericExporter scans the classpath for classes annotated with specified annotations in specific packages and mirrors them into Querydsl expression types.

Example with Querydsl annotations:

 
 GenericExporter exporter = new GenericExporter();
 exporter.setTargetFolder(new File("target/generated-sources/java"));
 exporter.export(com.example.domain.Entity.class.getPackage());

Example with JPA annotations:

 
 GenericExporter exporter = new GenericExporter();
 exporter.setKeywords(Keywords.JPA);
 exporter.setEntityAnnotation(Entity.class);
 exporter.setEmbeddableAnnotation(Embeddable.class);
 exporter.setEmbeddedAnnotation(Embedded.class);
 exporter.setSupertypeAnnotation(MappedSuperclass.class);
 exporter.setSkipAnnotation(Transient.class);
 exporter.setTargetFolder(new File("target/generated-sources/java"));
 exporter.export(com.example.domain.Entity.class.getPackage());

Author:: tiwe

Constructor Summary

Constructors
Constructor and Description
`GenericExporter()` Create a GenericExporter instance using the context classloader and default charset
`GenericExporter(java.nio.charset.Charset charset)` Create a GenericExporter instance using the context classloader and the given charset
`GenericExporter(java.lang.ClassLoader classLoader)` Create a GenericExporter instance using the given classloader and default charset
`GenericExporter(java.lang.ClassLoader classLoader, java.nio.charset.Charset charset)` Create a GenericExporter instance using the given classloader and charset for serializing source files

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnnotationHelper(AnnotationHelper annotationHelper)` Add a annotation helper object to process custom annotations
`void`	`addStopClass(java.lang.Class<?> cl)` Add a stop class to be used (default Object.class and Enum.class)
`void`	`export(java.lang.Class<?>... classes)` Export the given classes
`void`	`export(java.lang.Package... packages)` Export the given packages
`void`	`export(java.lang.String... packages)` Export the given packages
`java.util.Set<java.io.File>`	`getGeneratedFiles()` Return the set of generated files
`void`	`setCreateScalaSources(boolean createScalaSources)` Set whether Scala sources are generated
`void`	`setEmbeddableAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> embeddableAnnotation)` Set the embeddable annotation
`void`	`setEmbeddedAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> embeddedAnnotation)` Set the embedded annotation
`void`	`setEntityAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> entityAnnotation)` Set the entity annotation
`void`	`setGeneratedAnnotationClass(@Nullable java.lang.String generatedAnnotationClass)` Set the Generated annotation class.
`void`	`setHandleFields(boolean b)` Deprecated. Use `setPropertyHandling(PropertyHandling)` instead
`void`	`setHandleMethods(boolean b)` Deprecated. Use `setPropertyHandling(PropertyHandling)` instead
`void`	`setKeywords(java.util.Collection<java.lang.String> keywords)` Set the keywords to be used
`void`	`setNamePrefix(java.lang.String prefix)` Set the name prefix
`void`	`setNameSuffix(java.lang.String suffix)` Set the name suffix
`void`	`setPackageSuffix(java.lang.String suffix)` Set the package suffix
`void`	`setPropertyHandling(PropertyHandling propertyHandling)` Set the property handling mode
`void`	`setSerializerClass(java.lang.Class<? extends Serializer> serializerClass)` Set the serializer class to be used
`void`	`setSerializerConfig(SerializerConfig serializerConfig)` Set the serializer configuration to use
`void`	`setSkipAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> skipAnnotation)` Set the skip annotation
`void`	`setStrictMode(boolean s)` Set whether annotationless superclasses are handled or not (default: true)
`void`	`setSupertypeAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> supertypeAnnotation)` Set the supertype annotation
`void`	`setTargetFolder(java.io.File targetFolder)` Set the target folder for generated sources
`void`	`setTypeMappingsClass(java.lang.Class<? extends TypeMappings> typeMappingsClass)` Set the typemappings class to be used
`void`	`setUseFieldTypes(boolean b)` Set whether field types should be used instead of getter return types (default false)

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

- Constructor Detail
  - GenericExporter
```
public GenericExporter(java.lang.ClassLoader classLoader,
                       java.nio.charset.Charset charset)
```
    Create a GenericExporter instance using the given classloader and charset for serializing source files
    
    Parameters:
    
    classLoader - classloader to use
    
    charset - charset of target sources
  - GenericExporter
```
public GenericExporter(java.lang.ClassLoader classLoader)
```
    Create a GenericExporter instance using the given classloader and default charset
    
    Parameters:
    
    classLoader - classloader to use
  - GenericExporter
```
public GenericExporter(java.nio.charset.Charset charset)
```
    Create a GenericExporter instance using the context classloader and the given charset
    
    Parameters:
    
    charset - charset of target sources
  - GenericExporter
```
public GenericExporter()
```
    Create a GenericExporter instance using the context classloader and default charset
- Method Detail
  - export
```
public void export(java.lang.Package... packages)
```
    Export the given packages
    
    Parameters:
    
    packages - packages to be scanned
  - export
```
public void export(java.lang.String... packages)
```
    Export the given packages
    
    Parameters:
    
    packages - packages to be scanned
  - export
```
public void export(java.lang.Class<?>... classes)
```
    Export the given classes
    
    Parameters:
    
    classes - classes to be scanned
  - getGeneratedFiles
```
public java.util.Set<java.io.File> getGeneratedFiles()
```
    Return the set of generated files
    
    Returns:
    
    a set of generated files
  - setEntityAnnotation
```
public void setEntityAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> entityAnnotation)
```
    Set the entity annotation
    
    Parameters:
    
    entityAnnotation - entity annotation
  - setSupertypeAnnotation
```
public void setSupertypeAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> supertypeAnnotation)
```
    Set the supertype annotation
    
    Parameters:
    
    supertypeAnnotation - supertype annotation
  - setEmbeddableAnnotation
```
public void setEmbeddableAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> embeddableAnnotation)
```
    Set the embeddable annotation
    
    Parameters:
    
    embeddableAnnotation - embeddable annotation
  - setEmbeddedAnnotation
```
public void setEmbeddedAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> embeddedAnnotation)
```
    Set the embedded annotation
    
    Parameters:
    
    embeddedAnnotation - embedded annotation
  - setSkipAnnotation
```
public void setSkipAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> skipAnnotation)
```
    Set the skip annotation
    
    Parameters:
    
    skipAnnotation - skip annotation
  - setTargetFolder
```
public void setTargetFolder(java.io.File targetFolder)
```
    Set the target folder for generated sources
    
    Parameters:
    
    targetFolder -
  - setSerializerClass
```
public void setSerializerClass(java.lang.Class<? extends Serializer> serializerClass)
```
    Set the serializer class to be used
    
    Parameters:
    
    serializerClass -
  - setTypeMappingsClass
```
public void setTypeMappingsClass(java.lang.Class<? extends TypeMappings> typeMappingsClass)
```
    Set the typemappings class to be used
    
    Parameters:
    
    typeMappingsClass -
  - setCreateScalaSources
```
public void setCreateScalaSources(boolean createScalaSources)
```
    Set whether Scala sources are generated
    
    Parameters:
    
    createScalaSources -
  - setKeywords
```
public void setKeywords(java.util.Collection<java.lang.String> keywords)
```
    Set the keywords to be used
    
    Parameters:
    
    keywords -
  - setNamePrefix
```
public void setNamePrefix(java.lang.String prefix)
```
    Set the name prefix
    
    Parameters:
    
    prefix -
  - setNameSuffix
```
public void setNameSuffix(java.lang.String suffix)
```
    Set the name suffix
    
    Parameters:
    
    suffix -
  - setPackageSuffix
```
public void setPackageSuffix(java.lang.String suffix)
```
    Set the package suffix
    
    Parameters:
    
    suffix -
  - setHandleFields
```
@Deprecated
public void setHandleFields(boolean b)
```
    Deprecated. Use setPropertyHandling(PropertyHandling) instead
    
    Set whether fields are handled (default true)
    
    Parameters:
    
    b -
  - setHandleMethods
```
@Deprecated
public void setHandleMethods(boolean b)
```
    Deprecated. Use setPropertyHandling(PropertyHandling) instead
    
    Set whether methods are handled (default true)
    
    Parameters:
    
    b -
  - setPropertyHandling
```
public void setPropertyHandling(PropertyHandling propertyHandling)
```
    Set the property handling mode
    
    Parameters:
    
    propertyHandling -
  - setUseFieldTypes
```
public void setUseFieldTypes(boolean b)
```
    Set whether field types should be used instead of getter return types (default false)
    
    Parameters:
    
    b -
  - addStopClass
```
public void addStopClass(java.lang.Class<?> cl)
```
    Add a stop class to be used (default Object.class and Enum.class)
    
    Parameters:
    
    cl -
  - setStrictMode
```
public void setStrictMode(boolean s)
```
    Set whether annotationless superclasses are handled or not (default: true)
    
    Parameters:
    
    s -
  - setSerializerConfig
```
public void setSerializerConfig(SerializerConfig serializerConfig)
```
    Set the serializer configuration to use
    
    Parameters:
    
    serializerConfig -
  - addAnnotationHelper
```
public void addAnnotationHelper(AnnotationHelper annotationHelper)
```
    Add a annotation helper object to process custom annotations
    
    Parameters:
    
    annotationHelper -
  - setGeneratedAnnotationClass
```
public void setGeneratedAnnotationClass(@Nullable
                                        @Nullable java.lang.String generatedAnnotationClass)
```
    Set the Generated annotation class. Will default to java @Generated
    
    Parameters:
    
    generatedAnnotationClass - the fully qualified class name of the Single-Element Annotation (with String element) to be used on the generated sources, or null (defaulting to javax.annotation.Generated or javax.annotation.processing.Generated depending on the java version).
    
    See Also:
    
    Single-Element Annotation

Class GenericExporter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericExporter

GenericExporter

GenericExporter

GenericExporter

Method Detail

export

export

export

getGeneratedFiles

setEntityAnnotation

setSupertypeAnnotation

setEmbeddableAnnotation

setEmbeddedAnnotation

setSkipAnnotation

setTargetFolder

setSerializerClass

setTypeMappingsClass

setCreateScalaSources

setKeywords

setNamePrefix

setNameSuffix

setPackageSuffix

setHandleFields

setHandleMethods

setPropertyHandling

setUseFieldTypes

addStopClass

setStrictMode

setSerializerConfig

addAnnotationHelper

setGeneratedAnnotationClass