/*
 * Copyright (c) 2010 Mysema Ltd.
 * All rights reserved.
 * 
 */
package com.mysema.codegen;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.Collection;

import javax.annotation.Nullable;

import org.apache.commons.collections15.Transformer;

import com.mysema.codegen.model.Type;

/**
 * CodeWriter defines an interface for serializing Java source code
 * 
 * @author tiwe
 *
 */
public interface CodeWriter extends Appendable{

    CodeWriter annotation(Annotation annotation) throws IOException;

    CodeWriter annotation(Class<? extends Annotation> annotation) throws IOException;

    CodeWriter beginClass(Type type) throws IOException;

    CodeWriter beginClass(Type type, @Nullable Type superClass, Type... interfaces) throws IOException;

    <T> CodeWriter beginConstructor(Collection<T> params, Transformer<T, String> transformer) throws IOException;

    CodeWriter beginConstructor(String... params) throws IOException;

    CodeWriter beginInterface(Type type, Type... interfaces) throws IOException;

    CodeWriter beginLine(String... segments) throws IOException;

    <T> CodeWriter beginPublicMethod(Type returnType, String methodName, Collection<T> parameters, Transformer<T, String> transformer) throws IOException;

    CodeWriter beginPublicMethod(Type returnType, String methodName, String... args) throws IOException;

    <T> CodeWriter beginStaticMethod(Type type, String name, Collection<T> params, Transformer<T, String> transformer) throws IOException;

    CodeWriter beginStaticMethod(Type returnType, String methodName, String... args) throws IOException;

    CodeWriter end() throws IOException;

    CodeWriter field(Type type, String name) throws IOException;

    CodeWriter imports(Class<?>... imports) throws IOException;

    CodeWriter imports(Package... imports) throws IOException;
    
    CodeWriter importClasses(String... classes) throws IOException;
    
    CodeWriter importPackages(String... packages) throws IOException;

    CodeWriter javadoc(String... lines) throws IOException;

    CodeWriter line(String... segments) throws IOException;

    CodeWriter nl() throws IOException;

    CodeWriter packageDecl(String packageName) throws IOException;
    
    CodeWriter privateField(Type type, String name) throws IOException;

    CodeWriter privateFinal(Type type, String name) throws IOException;

    CodeWriter privateFinal(Type type, String name, String value) throws IOException;

    CodeWriter privateStaticFinal(Type type, String name, String value) throws IOException;

    CodeWriter protectedField(Type type, String name) throws IOException;
    
    CodeWriter protectedFinal(Type type, String name) throws IOException;

    CodeWriter protectedFinal(Type type, String name, String value) throws IOException;
    
    CodeWriter publicField(Type type, String name) throws IOException;

    CodeWriter publicFinal(Type type, String name) throws IOException;

    CodeWriter publicFinal(Type type, String name, String value) throws IOException;

    CodeWriter publicStaticFinal(Type type, String name, String value) throws IOException;

    CodeWriter staticimports(Class<?>... imports) throws IOException;

    CodeWriter suppressWarnings(String type) throws IOException;

}