├── .gitignore ├── .travis.yml ├── src ├── main │ └── java │ │ └── org │ │ └── mdkt │ │ └── compiler │ │ ├── CompilationException.java │ │ ├── DynamicClassLoader.java │ │ ├── SourceCode.java │ │ ├── CompiledCode.java │ │ ├── ExtendedStandardJavaFileManager.java │ │ └── InMemoryJavaCompiler.java └── test │ └── java │ └── org │ └── mdkt │ └── compiler │ └── InMemoryJavaCompilerTest.java ├── README.md ├── pom.xml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | InMemoryJavaCompiler.iml 3 | target 4 | release.properties* 5 | .settings 6 | .classpath 7 | .project -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - oraclejdk8 4 | 5 | script: "mvn cobertura:cobertura" 6 | 7 | after_success: 8 | - bash <(curl -s https://codecov.io/bash) 9 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/CompilationException.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | public class CompilationException extends RuntimeException { 4 | private static final long serialVersionUID = 5272588827551900536L; 5 | 6 | public CompilationException(String msg) { 7 | super(msg); 8 | } 9 | 10 | } 11 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/DynamicClassLoader.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import java.util.HashMap; 4 | import java.util.Map; 5 | 6 | public class DynamicClassLoader extends ClassLoader { 7 | 8 | private Map customCompiledCode = new HashMap<>(); 9 | 10 | public DynamicClassLoader(ClassLoader parent) { 11 | super(parent); 12 | } 13 | 14 | public void addCode(CompiledCode cc) { 15 | customCompiledCode.put(cc.getName(), cc); 16 | } 17 | 18 | @Override 19 | protected Class findClass(String name) throws ClassNotFoundException { 20 | CompiledCode cc = customCompiledCode.get(name); 21 | if (cc == null) { 22 | return super.findClass(name); 23 | } 24 | byte[] byteCode = cc.getByteCode(); 25 | return defineClass(name, byteCode, 0, byteCode.length); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/SourceCode.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import javax.tools.SimpleJavaFileObject; 4 | import java.io.IOException; 5 | import java.net.URI; 6 | 7 | /** 8 | * Created by trung on 5/3/15. 9 | */ 10 | public class SourceCode extends SimpleJavaFileObject { 11 | private String contents = null; 12 | private String className; 13 | 14 | public SourceCode(String className, String contents) throws Exception { 15 | super(URI.create("string:///" + className.replace('.', '/') 16 | + Kind.SOURCE.extension), Kind.SOURCE); 17 | this.contents = contents; 18 | this.className = className; 19 | } 20 | 21 | public String getClassName() { 22 | return className; 23 | } 24 | 25 | public CharSequence getCharContent(boolean ignoreEncodingErrors) 26 | throws IOException { 27 | return contents; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/CompiledCode.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import javax.tools.SimpleJavaFileObject; 4 | import java.io.ByteArrayOutputStream; 5 | import java.io.IOException; 6 | import java.io.OutputStream; 7 | import java.net.URI; 8 | 9 | /** 10 | * Created by trung on 5/3/15. 11 | */ 12 | public class CompiledCode extends SimpleJavaFileObject { 13 | private ByteArrayOutputStream baos = new ByteArrayOutputStream(); 14 | private String className; 15 | 16 | public CompiledCode(String className) throws Exception { 17 | super(new URI(className), Kind.CLASS); 18 | this.className = className; 19 | } 20 | 21 | public String getClassName() { 22 | return className; 23 | } 24 | 25 | @Override 26 | public OutputStream openOutputStream() throws IOException { 27 | return baos; 28 | } 29 | 30 | public byte[] getByteCode() { 31 | return baos.toByteArray(); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/ExtendedStandardJavaFileManager.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import java.io.FileNotFoundException; 4 | import java.io.IOException; 5 | import java.util.ArrayList; 6 | import java.util.Arrays; 7 | import java.util.List; 8 | 9 | import javax.tools.FileObject; 10 | import javax.tools.ForwardingJavaFileManager; 11 | import javax.tools.JavaFileManager; 12 | import javax.tools.JavaFileObject; 13 | 14 | /** 15 | * Created by trung on 5/3/15. Edited by turpid-monkey on 9/25/15, completed 16 | * support for multiple compile units. 17 | */ 18 | public class ExtendedStandardJavaFileManager extends 19 | ForwardingJavaFileManager { 20 | 21 | private List compiledCode = new ArrayList(); 22 | private DynamicClassLoader cl; 23 | 24 | /** 25 | * Creates a new instance of ForwardingJavaFileManager. 26 | * 27 | * @param fileManager 28 | * delegate to this file manager 29 | * @param cl 30 | */ 31 | protected ExtendedStandardJavaFileManager(JavaFileManager fileManager, 32 | DynamicClassLoader cl) { 33 | super(fileManager); 34 | this.cl = cl; 35 | } 36 | 37 | @Override 38 | public JavaFileObject getJavaFileForOutput( 39 | JavaFileManager.Location location, String className, 40 | JavaFileObject.Kind kind, FileObject sibling) throws IOException { 41 | 42 | try { 43 | CompiledCode innerClass = new CompiledCode(className); 44 | compiledCode.add(innerClass); 45 | cl.addCode(innerClass); 46 | return innerClass; 47 | } catch (Exception e) { 48 | throw new RuntimeException( 49 | "Error while creating in-memory output file for " 50 | + className, e); 51 | } 52 | } 53 | 54 | @Override 55 | public ClassLoader getClassLoader(JavaFileManager.Location location) { 56 | return cl; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | **Update 09/22/2017**: I've been silent for long time (I'm into Golang lately hence putting Java aside) despite the fact that there are lots of interests to make this mini tool better. I'll kick off my effort to improve this tool from now on by reviewing outstanding issues and PRs 2 | 3 | # InMemoryJavaCompiler [![Build Status](https://travis-ci.org/trung/InMemoryJavaCompiler.svg?branch=master)](https://travis-ci.org/trung/InMemoryJavaCompiler) [![codecov](https://codecov.io/gh/trung/InMemoryJavaCompiler/branch/master/graph/badge.svg)](https://codecov.io/gh/trung/InMemoryJavaCompiler) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ftrung%2FInMemoryJavaCompiler.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Ftrung%2FInMemoryJavaCompiler?ref=badge_shield) 4 | 5 | Samples with utility classes to compile java source code in memory 6 | 7 | After taking huge effort to look for example on the internet and found nothing work. I decided to create a very simple version. 8 | 9 | **Note**: Please make sure you use JDK in your runtime 10 | 11 | E.g.: 12 | 13 | StringBuilder sourceCode = new StringBuilder(); 14 | sourceCode.append("package org.mdkt;\n"); 15 | sourceCode.append("public class HelloClass {\n"); 16 | sourceCode.append(" public String hello() { return \"hello\"; }"); 17 | sourceCode.append("}"); 18 | 19 | Class helloClass = InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 20 | 21 | If you are looking for more examples, please look at unit tests in the `src/test/java` folder 22 | 23 | Artifact is pushed to Sonatype OSS Releases Repository 24 | 25 | https://oss.sonatype.org/content/repositories/releases/ 26 | 27 | Maven dependency: 28 | 29 | 30 | org.mdkt.compiler 31 | InMemoryJavaCompiler 32 | 1.3.0 33 | 34 | 35 | 36 | ## License 37 | [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ftrung%2FInMemoryJavaCompiler.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Ftrung%2FInMemoryJavaCompiler?ref=badge_large) 38 | -------------------------------------------------------------------------------- /src/main/java/org/mdkt/compiler/InMemoryJavaCompiler.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import java.util.*; 4 | 5 | import javax.tools.*; 6 | 7 | /** 8 | * Compile Java sources in-memory 9 | */ 10 | public class InMemoryJavaCompiler { 11 | private JavaCompiler javac; 12 | private DynamicClassLoader classLoader; 13 | private Iterable options; 14 | boolean ignoreWarnings = false; 15 | 16 | private Map sourceCodes = new HashMap(); 17 | 18 | public static InMemoryJavaCompiler newInstance() { 19 | return new InMemoryJavaCompiler(); 20 | } 21 | 22 | private InMemoryJavaCompiler() { 23 | this.javac = ToolProvider.getSystemJavaCompiler(); 24 | this.classLoader = new DynamicClassLoader(ClassLoader.getSystemClassLoader()); 25 | } 26 | 27 | public InMemoryJavaCompiler useParentClassLoader(ClassLoader parent) { 28 | this.classLoader = new DynamicClassLoader(parent); 29 | return this; 30 | } 31 | 32 | /** 33 | * @return the class loader used internally by the compiler 34 | */ 35 | public ClassLoader getClassloader() { 36 | return classLoader; 37 | } 38 | 39 | /** 40 | * Options used by the compiler, e.g. '-Xlint:unchecked'. 41 | * 42 | * @param options 43 | * @return 44 | */ 45 | public InMemoryJavaCompiler useOptions(String... options) { 46 | this.options = Arrays.asList(options); 47 | return this; 48 | } 49 | 50 | /** 51 | * Ignore non-critical compiler output, like unchecked/unsafe operation 52 | * warnings. 53 | * 54 | * @return 55 | */ 56 | public InMemoryJavaCompiler ignoreWarnings() { 57 | ignoreWarnings = true; 58 | return this; 59 | } 60 | 61 | /** 62 | * Compile all sources 63 | * 64 | * @return Map containing instances of all compiled classes 65 | * @throws Exception 66 | */ 67 | public Map> compileAll() throws Exception { 68 | if (sourceCodes.size() == 0) { 69 | throw new CompilationException("No source code to compile"); 70 | } 71 | Collection compilationUnits = sourceCodes.values(); 72 | CompiledCode[] code; 73 | 74 | code = new CompiledCode[compilationUnits.size()]; 75 | Iterator iter = compilationUnits.iterator(); 76 | for (int i = 0; i < code.length; i++) { 77 | code[i] = new CompiledCode(iter.next().getClassName()); 78 | } 79 | DiagnosticCollector collector = new DiagnosticCollector<>(); 80 | ExtendedStandardJavaFileManager fileManager = new ExtendedStandardJavaFileManager(javac.getStandardFileManager(null, null, null), classLoader); 81 | JavaCompiler.CompilationTask task = javac.getTask(null, fileManager, collector, options, null, compilationUnits); 82 | boolean result = task.call(); 83 | if (!result || collector.getDiagnostics().size() > 0) { 84 | StringBuffer exceptionMsg = new StringBuffer(); 85 | exceptionMsg.append("Unable to compile the source"); 86 | boolean hasWarnings = false; 87 | boolean hasErrors = false; 88 | for (Diagnostic d : collector.getDiagnostics()) { 89 | switch (d.getKind()) { 90 | case NOTE: 91 | case MANDATORY_WARNING: 92 | case WARNING: 93 | hasWarnings = true; 94 | break; 95 | case OTHER: 96 | case ERROR: 97 | default: 98 | hasErrors = true; 99 | break; 100 | } 101 | exceptionMsg.append("\n").append("[kind=").append(d.getKind()); 102 | exceptionMsg.append(", ").append("line=").append(d.getLineNumber()); 103 | exceptionMsg.append(", ").append("message=").append(d.getMessage(Locale.US)).append("]"); 104 | } 105 | if (hasWarnings && !ignoreWarnings || hasErrors) { 106 | throw new CompilationException(exceptionMsg.toString()); 107 | } 108 | } 109 | 110 | Map> classes = new HashMap>(); 111 | for (String className : sourceCodes.keySet()) { 112 | classes.put(className, classLoader.loadClass(className)); 113 | } 114 | return classes; 115 | } 116 | 117 | /** 118 | * Compile single source 119 | * 120 | * @param className 121 | * @param sourceCode 122 | * @return 123 | * @throws Exception 124 | */ 125 | public Class compile(String className, String sourceCode) throws Exception { 126 | return addSource(className, sourceCode).compileAll().get(className); 127 | } 128 | 129 | /** 130 | * Add source code to the compiler 131 | * 132 | * @param className 133 | * @param sourceCode 134 | * @return 135 | * @throws Exception 136 | * @see {@link #compileAll()} 137 | */ 138 | public InMemoryJavaCompiler addSource(String className, String sourceCode) throws Exception { 139 | sourceCodes.put(className, new SourceCode(className, sourceCode)); 140 | return this; 141 | } 142 | } 143 | -------------------------------------------------------------------------------- /src/test/java/org/mdkt/compiler/InMemoryJavaCompilerTest.java: -------------------------------------------------------------------------------- 1 | package org.mdkt.compiler; 2 | 3 | import java.util.List; 4 | import java.util.Map; 5 | 6 | import org.junit.Assert; 7 | import org.junit.Rule; 8 | import org.junit.Test; 9 | import org.junit.rules.ExpectedException; 10 | import org.slf4j.Logger; 11 | import org.slf4j.LoggerFactory; 12 | 13 | public class InMemoryJavaCompilerTest { 14 | private static final Logger logger = LoggerFactory.getLogger(InMemoryJavaCompilerTest.class); 15 | 16 | @Rule 17 | public ExpectedException thrown = ExpectedException.none(); 18 | 19 | @Test 20 | public void compile_WhenTypical() throws Exception { 21 | StringBuffer sourceCode = new StringBuffer(); 22 | 23 | sourceCode.append("package org.mdkt;\n"); 24 | sourceCode.append("public class HelloClass {\n"); 25 | sourceCode.append(" public String hello() { return \"hello\"; }"); 26 | sourceCode.append("}"); 27 | 28 | Class helloClass = InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 29 | Assert.assertNotNull(helloClass); 30 | Assert.assertEquals(1, helloClass.getDeclaredMethods().length); 31 | } 32 | 33 | @Test 34 | public void compileAll_WhenTypical() throws Exception { 35 | String cls1 = "public class A{ public B b() { return new B(); }}"; 36 | String cls2 = "public class B{ public String toString() { return \"B!\"; }}"; 37 | 38 | Map> compiled = InMemoryJavaCompiler.newInstance().addSource("A", cls1).addSource("B", cls2).compileAll(); 39 | 40 | Assert.assertNotNull(compiled.get("A")); 41 | Assert.assertNotNull(compiled.get("B")); 42 | 43 | Class aClass = compiled.get("A"); 44 | Object a = aClass.newInstance(); 45 | Assert.assertEquals("B!", aClass.getMethod("b").invoke(a).toString()); 46 | } 47 | 48 | @Test 49 | public void compile_WhenSourceContainsInnerClasses() throws Exception { 50 | StringBuffer sourceCode = new StringBuffer(); 51 | 52 | sourceCode.append("package org.mdkt;\n"); 53 | sourceCode.append("public class HelloClass {\n"); 54 | sourceCode.append(" private static class InnerHelloWorld { int inner; }\n"); 55 | sourceCode.append(" public String hello() { return \"hello\"; }"); 56 | sourceCode.append("}"); 57 | 58 | Class helloClass = InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 59 | Assert.assertNotNull(helloClass); 60 | Assert.assertEquals(1, helloClass.getDeclaredMethods().length); 61 | } 62 | 63 | @Test 64 | public void compile_whenError() throws Exception { 65 | thrown.expect(CompilationException.class); 66 | thrown.expectMessage("Unable to compile the source"); 67 | StringBuffer sourceCode = new StringBuffer(); 68 | 69 | sourceCode.append("package org.mdkt;\n"); 70 | sourceCode.append("public classHelloClass {\n"); 71 | sourceCode.append(" public String hello() { return \"hello\"; }"); 72 | sourceCode.append("}"); 73 | InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 74 | } 75 | 76 | @Test 77 | public void compile_WhenFailOnWarnings() throws Exception { 78 | thrown.expect(CompilationException.class); 79 | StringBuffer sourceCode = new StringBuffer(); 80 | 81 | sourceCode.append("package org.mdkt;\n"); 82 | sourceCode.append("public class HelloClass {\n"); 83 | sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); 84 | sourceCode.append("}"); 85 | InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 86 | } 87 | 88 | @Test 89 | public void compile_WhenIgnoreWarnings() throws Exception { 90 | StringBuffer sourceCode = new StringBuffer(); 91 | 92 | sourceCode.append("package org.mdkt;\n"); 93 | sourceCode.append("public class HelloClass {\n"); 94 | sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); 95 | sourceCode.append("}"); 96 | Class helloClass = InMemoryJavaCompiler.newInstance().ignoreWarnings().compile("org.mdkt.HelloClass", sourceCode.toString()); 97 | List res = (List) helloClass.getMethod("hello").invoke(helloClass.newInstance()); 98 | Assert.assertEquals(0, res.size()); 99 | } 100 | 101 | @Test 102 | public void compile_WhenWarningsAndErrors() throws Exception { 103 | thrown.expect(CompilationException.class); 104 | StringBuffer sourceCode = new StringBuffer(); 105 | 106 | sourceCode.append("package org.mdkt;\n"); 107 | sourceCode.append("public class HelloClass extends xxx {\n"); 108 | sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); 109 | sourceCode.append("}"); 110 | try { 111 | InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); 112 | } catch (Exception e) { 113 | logger.info("Exception caught: {}", e); 114 | throw e; 115 | } 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4.0.0 3 | 4 | org.mdkt.compiler 5 | InMemoryJavaCompiler 6 | 1.4.0-SNAPSHOT 7 | jar 8 | https://github.com/trung/InMemoryJavaCompiler 9 | 10 | InMemoryJavaCompiler 11 | Small utility to compile java code in memory 12 | 13 | 14 | 1.8 15 | 1.8 16 | UTF-8 17 | 3.2 18 | 1.6.3 19 | 2.5.1 20 | gpg2 21 | 22 | 23 | 1.7.5 24 | 4.12 25 | 26 | 27 | 28 | 29 | Apache License, Version 2.0 30 | http://www.apache.org/licenses/LICENSE-2.0.txt 31 | repo 32 | 33 | 34 | 35 | 36 | https://github.com/trung/InMemoryJavaCompiler/issues 37 | GitHub Issues 38 | 39 | 40 | 41 | https://github.com/trung/InMemoryJavaCompiler 42 | scm:git:git://github.com/trung/InMemoryJavaCompiler 43 | scm:git:git@github.com:trung/InMemoryJavaCompiler.git 44 | HEAD 45 | 46 | 47 | 48 | 49 | ossrh 50 | https://oss.sonatype.org/content/repositories/snapshots 51 | 52 | 53 | ossrh 54 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 55 | 56 | 57 | 58 | 59 | 60 | Trung Nguyen 61 | trung.n.k@gmail.com 62 | Github 63 | https://github.com/trung 64 | 65 | 66 | 67 | 68 | 69 | org.slf4j 70 | slf4j-api 71 | ${slf4j.version} 72 | 73 | 74 | org.slf4j 75 | slf4j-jdk14 76 | ${slf4j.version} 77 | test 78 | 79 | 80 | junit 81 | junit 82 | ${junit.version} 83 | test 84 | 85 | 86 | 87 | 88 | 89 | 90 | org.codehaus.mojo 91 | cobertura-maven-plugin 92 | 2.7 93 | 94 | 95 | html 96 | xml 97 | 98 | 99 | 100 | 101 | 102 | org.apache.maven.plugins 103 | maven-compiler-plugin 104 | ${maven-compiler-plugin.version} 105 | 106 | 107 | org.sonatype.plugins 108 | nexus-staging-maven-plugin 109 | ${nexus-staging-maven-plugin.version} 110 | true 111 | 112 | ossrh 113 | https://oss.sonatype.org/ 114 | true 115 | 116 | 117 | 118 | org.apache.maven.plugins 119 | maven-release-plugin 120 | ${maven-release-plugin.version} 121 | 122 | true 123 | false 124 | release 125 | deploy 126 | 127 | 128 | 129 | 130 | 131 | 132 | release 133 | 134 | 135 | 136 | org.apache.maven.plugins 137 | maven-source-plugin 138 | 2.2.1 139 | 140 | 141 | attach-sources 142 | 143 | jar-no-fork 144 | 145 | 146 | 147 | 148 | 149 | org.apache.maven.plugins 150 | maven-javadoc-plugin 151 | 2.9.1 152 | 153 | 154 | attach-javadocs 155 | 156 | jar 157 | 158 | 159 | -Xdoclint:none 160 | 161 | 162 | 163 | 164 | 165 | org.apache.maven.plugins 166 | maven-gpg-plugin 167 | 1.5 168 | 169 | 170 | sign-artifacts 171 | verify 172 | 173 | sign 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------