com.baidu.bjf.remoting.protobuf.code.ICodeGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jprotobuf Show documentation

A useful utility library for java programmer using google protobuf.

There is a newer version: 2.4.23

/*
 * Copyright (c) Baidu Inc. All rights reserved.
 * 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.baidu.bjf.remoting.protobuf.code;

import java.io.File;
import java.util.Set;

/**
 * The Interface ICodeGenerator.
 * 
 * @author xiemalin
 * @since 1.10.7
 */
public interface ICodeGenerator {

    /** auto proxied suffix class name. */
    String DEFAULT_SUFFIX_CLASSNAME = "$$JProtoBufClass";

    /**
     * line break for editor
     */
    String LINE_BREAK = "\n";

    /**
     * java line end
     */
    String JAVA_END = ";";

    /**
     * line break for JAVA
     */
    String JAVA_LINE_BREAK = JAVA_END + LINE_BREAK;

    /**
     * auto proxied suffix class name
     */

    String PACKAGE_SPLIT = ".";

    String CLASS_JOINER = "$";

    /**
     * 
     */
    String JAVA_CLASS_FILE_SUFFIX = ".class";

    /**
     * Sets the output path. if set should write generated source code to target path
     *
     * @param outputPath the new output path
     */
    void setOutputPath(File outputPath);

    /**
     * Checks if is debug.
     *
     * @return true, if is debug
     */
    boolean isDebug();

    /**
     * Sets the debug. if enabled print out source code after generated
     * 
     * @see #getCode()
     *
     * @param debug the new debug
     */
    void setDebug(boolean debug);

    /**
     * Gets the class name.
     *
     * @return the class name
     */
    String getClassName();

    /**
     * Gets the package.
     *
     * @return the package
     */
    String getPackage();

    /**
     * Gets the full class name.
     *
     * @return the full class name
     */
    String getFullClassName();

    /**
     * Gets the code.
     *
     * @return the code
     */
    String getCode();

    /**
     * Gets the relative proxy classes.
     *
     * @return the relative proxy classes
     */
    Set> getRelativeProxyClasses();

}