Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-05-06 10:06:21 +02:00
Code Issues Packages Projects Releases Activity

implementing an annotation scanner to replace the extension scanner

Browse Source
This commit is contained in:
Sebastian Sdorra
2013-01-15 16:55:07 +01:00
parent 52ffb42b3d
commit 6f5780b9df
9 changed files with 891 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
scm-core/src/main/java/sonia/scm/plugin/ext/AnnotatedClass.java Normal file
View File

@@ -0,0 +1,93 @@
/**
* Copyright (c) 2010, Sebastian Sdorra All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. Neither the name of SCM-Manager;
* nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.plugin.ext;
//~--- JDK imports ------------------------------------------------------------
import java.lang.annotation.Annotation;
/**
* Represents a annotated class, collected by a {@link AnnotationCollector}.
*
* @author Sebastian Sdorra
* @since 1.26
*
* @param <T>
*/
public class AnnotatedClass<T extends Annotation>
{
/**
* Constructs a new annotated class.
*
*
* @param annotation found annotation
* @param annotatedClass annotated class
*/
public AnnotatedClass(T annotation, Class<?> annotatedClass)
{
this.annotation = annotation;
this.annotatedClass = annotatedClass;
}
//~--- get methods ----------------------------------------------------------
/**
* Returns the annotated class.
*
*
* @return annotated class
*/
public Class<?> getAnnotatedClass()
{
return annotatedClass;
}
/**
* Returns the annotation.
*
*
* @return annotation
*/
public T getAnnotation()
{
return annotation;
}
//~--- fields ---------------------------------------------------------------
/** annotated class */
private Class<?> annotatedClass;
/** annotation */
private T annotation;
}

86
scm-core/src/main/java/sonia/scm/plugin/ext/AnnotationCollector.java Normal file
View File

@@ -0,0 +1,86 @@
/**
* Copyright (c) 2010, Sebastian Sdorra All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. Neither the name of SCM-Manager;
* nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.plugin.ext;
//~--- non-JDK imports --------------------------------------------------------
import com.google.common.collect.Sets;
//~--- JDK imports ------------------------------------------------------------
import java.lang.annotation.Annotation;
import java.util.Set;
/**
* Collects all annotated classes found by a {@link AnnotationScanner}.
*
* @author Sebastian Sdorra
* @since 1.26
*
* @param <T>
*/
public class AnnotationCollector<T extends Annotation>
implements AnnotationProcessor<T>
{
/**
* Creates a new annotation collector.
*
*
* @param annotation found annotation
* @param annotatedClass annotated class
*/
@Override
public void processAnnotation(T annotation, Class<?> annotatedClass)
{
annotatedClasses.add(new AnnotatedClass<T>(annotation, annotatedClass));
}
//~--- get methods ----------------------------------------------------------
/**
* Returns the annotated classes.
*
*
* @return set of annotated classes
*/
public Set<AnnotatedClass<T>> getAnnotatedClasses()
{
return annotatedClasses;
}
//~--- fields ---------------------------------------------------------------
/** set of annotated classes */
private Set<AnnotatedClass<T>> annotatedClasses = Sets.newHashSet();
}

57
scm-core/src/main/java/sonia/scm/plugin/ext/AnnotationProcessor.java Normal file
View File

@@ -0,0 +1,57 @@
/**
* Copyright (c) 2010, Sebastian Sdorra All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. Neither the name of SCM-Manager;
* nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.plugin.ext;
//~--- JDK imports ------------------------------------------------------------
import java.lang.annotation.Annotation;
/**
* Processor for annotated classes found by a {@link AnnotationScanner}.
*
* @author Sebastian Sdorra
* @since 1.26
*
* @param <T>
*/
public interface AnnotationProcessor<T extends Annotation>
{
/**
* Process annotated class.
*
*
* @param annotation found annotation
* @param annotatedClass annotated class
*/
public void processAnnotation(T annotation, Class<?> annotatedClass);
}

83
scm-core/src/main/java/sonia/scm/plugin/ext/AnnotationScanner.java Normal file
View File

@@ -0,0 +1,83 @@
/**
* Copyright (c) 2010, Sebastian Sdorra All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. Neither the name of SCM-Manager;
* nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.plugin.ext;
//~--- JDK imports ------------------------------------------------------------
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
/**
* The annotation scanner is able to scan archives and directories for
* annotated classes. Each annotated class can be processed with a
* {@link AnnotationProcessor}.
*
* @author Sebastian Sdorra
* @since 1.26
*/
public interface AnnotationScanner
{
/**
* Adds a {@link AnnotationProcessor} for the given annotation.
*
*
* @param annotationClass class of the annotation
* @param processor processor
* @param <T> annotation type
*/
public <T extends Annotation> void addProcessor(Class<T> annotationClass,
AnnotationProcessor<T> processor);
/**
* Scans the given archive for annotations.
*
*
* @param archive archive input stream
*
* @throws IOException
*/
public void scanArchive(InputStream archive) throws IOException;
/**
* Scans a directory for annotated classes.
*
*
* @param directory directory to scan
*
* @throws IOException
*/
public void scanDirectory(File directory) throws IOException;
}

60
scm-core/src/main/java/sonia/scm/plugin/ext/AnnotationScannerFactory.java Normal file
View File

@@ -0,0 +1,60 @@
/**
* Copyright (c) 2010, Sebastian Sdorra All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. 2. Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. 3. Neither the name of SCM-Manager;
* nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.plugin.ext;
//~--- JDK imports ------------------------------------------------------------
import java.util.Collection;
/**
* Factory class for {@link AnnotationScanner}.
*
* @author Sebastian Sdorra
* @since 1.26
*/
public interface AnnotationScannerFactory
{
/**
* Returns a new {@link AnnotationScanner} for the given class loader
* and packages.
*
*
*
* @param classLoader class loader
* @param packages packages to scann
*
* @return new annotation scanner
*/
public AnnotationScanner create(ClassLoader classLoader,
Collection<String> packages);
}