Markdown

[Spacerat]

Try renaming your readme to readme.markdown, then adding newlines before all blocks of -. It'll look something like....

Compile In Memory

Rikki Prince - rikki@prince.io

Prerequisites

• BeerPump.jar
• FlexiFile.jar

  Introduction

Code influenced by examples on the web, which now seem to have disappeared. URLs for original source are in the code comments.

This code was altered and simplified from the example code referenced, to make it into this usable library.

File Summary (in order of usefulness!)

MemoryCompiler.java

• You should create one of these.
• It keeps references to a compiler, file managers and class loader.
• Use .compile() and .run() or .compileAndRun(), to do your thing!
• detectClassName() uses a regular expression to find the name of the first class in the source.

CompileTest.java

• a tester class containing only a main method which constructs a couple of pieces of source code, compiles and runs them.

ClassNameNotFoundException.java

• Used to indicate failure of the MemoryCompile.detectClassName() method.

CompilerNotAccessibleException.java

• Used to indicate that when attempting to retrieve the JDK's compiler, 'null' was returned.

JavaSourceFromString.java

• a SimpleJavaFileObject that simply stores a string containing the source code

MemoryFileManager.java

• essentially a Map of filename strings to JavaFileObjects. In this case, only MemoryClassFile: all other file types passed to super.

MemoryClassFile.java

• wrapper around a ByteArrayOutputStream, so compiler can write byte code into it, and class loader can read byte code from it.

MemoryClassLoader.java

• looks for the requested class in the MemoryFileManager, then loads the bytes from the MemoryClassFile. If it doesn't exist, passes request to super.

LoopCompiler.java

• erm, not sure! TODO: work out what this does.

Order of Operations

1. Call MemoryCompiler.compile(String sourceCode, String className).
2. This creates a new JavaSourceFromString object.
3. Creates an Iterable list of JavaFileObjects called "compilationUnits".
4. compilationUnits is passed to the compiler.getTask() method, along with the MemoryFileManager.
5. CompilationTask is call()ed.
6. A new MemoryClassLoader is created from the updated FileManager.

[rikkiprince]

Yeah, I realised that. I filled in all the markdown, and it didn't work, so I went to investigate, and found out that I needed to name it README.md. But then I decided that most people won't understand what a .md file is, and get confused, and not confusing people was more important to me than making my readme look nice on Github.

If Github wanted to be clever, they could detect whether I'm using markdown from the content...