All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.codemodel.package-info Maven / Gradle / Ivy

There is a newer version: 4.0.5
Show newest version
/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

/**
 * 

Library for generating Java source code

. * *

* CodeModel is a library that allows you to generate Java source * code in a type-safe fashion. * *

* With CodeModel, you build the java source code by first building AST, * then writing it out as text files that is Java source files. * The AST looks like this: * *

* You bulid this tree mostly from top-down. So, you first create * a new {@link JDefinedClass} from {@link JCodeModel}, then you * create a {@link JMethod} from {@link JDefinedClass}, and so on. * *

* This design brings the following benefits: * *

    *
  • source code can be written in random order *
  • generated source code nicely imports other classes *
  • generated source code is lexically always correct * (no unbalanced parenthesis, etc.) *
  • code generation becomes relatively type-safe *
* * The price you pay for that is * increased memory footprint and the generation speed. * See performance section for * more discussions about the performance and possible improvements. * * *

Using CodeModel

*

* {@link com.sun.codemodel.JCodeModel} is the entry point to * the library. See its javadoc for more details about how to use * CodeModel. * * * *

Performance

*

* Generally speaking, CodeModel is expected to be used in * an environment where the resource constraint is not severe. * Therefore, we haven't spent much effort in trying to make * this library lean and mean. * *

* That said, we did some benchmark and performance analysis. * In case anyone is interested in making this library * better performance wise, here's the findings. * *

* {@link java.util.List}s {@link java.util.Map}s, and other collections take up * a lot of space. Allocating those things lazily is generally * a good idea. * *

* Compared to template-based code generator, the writing operation * is slow, as it needs to traverse each AST node. Consider * pre-encoding tokens (like 'public') to the target encoding, * and consider exploting the subtree equivalence. * */ package com.sun.codemodel;





© 2015 - 2024 Weber Informatics LLC | Privacy Policy