Examples with JavadocEscapeWriter com.sun.codemodel.util.JavadocEscapeWriter used on opensource projects

Example 1 with JavadocEscapeWriter

use of com.sun.codemodel.util.JavadocEscapeWriter in project jaxb-ri by eclipse-ee4j.

the class SimpleTypeBuilder method bindToTypeSafeEnum.

/**
 * Builds a type-safe enum conversion from a simple type
 * with enumeration facets.
 *
 * @param className
 *      The class name of the type-safe enum. Or null to
 *      create a default name.
 * @param javadoc
 *      Additional javadoc that will be added at the beginning of the
 *      class, or null if none is necessary.
 * @param members
 *      A map from enumeration values (as String) to BIEnumMember objects.
 *      if some of the value names need to be overrided.
 *      Cannot be null, but the map may not contain entries
 *      for all enumeration values.
 * @param loc
 *      The source location where the above customizations are
 *      specified, or null if none is available.
 */
private TypeUse bindToTypeSafeEnum(XSRestrictionSimpleType type, String className, String javadoc, Map<String, BIEnumMember> members, EnumMemberMode mode, Locator loc) {
    if (// use the location of the simple type as the default
    loc == null)
        loc = type.getLocator();
    if (className == null) {
        // the simple type must be a global one.
        if (!type.isGlobal()) {
            getErrorReporter().error(loc, Messages.ERR_NO_ENUM_NAME_AVAILABLE);
            // recover by returning a meaningless conversion
            return CBuiltinLeafInfo.STRING;
        }
        className = type.getName();
    }
    // we apply name conversion in any case
    className = builder.deriveName(className, type);
    {
        // compute Javadoc
        StringWriter out = new StringWriter();
        SchemaWriter sw = new SchemaWriter(new JavadocEscapeWriter(out));
        type.visit((XSVisitor) sw);
        if (javadoc != null)
            javadoc += "\n\n";
        else
            javadoc = "";
        javadoc += Messages.format(Messages.JAVADOC_HEADING, type.getName()) + "\n<pre>\n" + out.getBuffer() + "</pre>";
    }
    // build base type
    refererStack.push(type.getSimpleBaseType());
    TypeUse use = build(type.getSimpleBaseType());
    refererStack.pop();
    if (use.isCollection())
        // can't bind a list to enum constant
        return null;
    // for now just ignore that case
    CNonElement baseDt = use.getInfo();
    if (baseDt instanceof CClassInfo)
        // can't bind to an enum if the base is a class, since we don't have the value constrctor
        return null;
    // if the member names collide, re-generate numbered constant names.
    XSFacet[] errorRef = new XSFacet[1];
    List<CEnumConstant> memberList = buildCEnumConstants(type, false, members, errorRef);
    if (memberList == null || checkMemberNameCollision(memberList) != null) {
        switch(mode) {
            case SKIP:
                // abort
                return null;
            case ERROR:
                // error
                if (memberList == null) {
                    getErrorReporter().error(errorRef[0].getLocator(), Messages.ERR_CANNOT_GENERATE_ENUM_NAME, errorRef[0].getValue());
                } else {
                    CEnumConstant[] collision = checkMemberNameCollision(memberList);
                    getErrorReporter().error(collision[0].getLocator(), Messages.ERR_ENUM_MEMBER_NAME_COLLISION, collision[0].getName());
                    getErrorReporter().error(collision[1].getLocator(), Messages.ERR_ENUM_MEMBER_NAME_COLLISION_RELATED);
                }
                // recover from error
                return null;
            case GENERATE:
                // generate
                memberList = buildCEnumConstants(type, true, members, null);
                break;
        }
    }
    if (memberList.isEmpty()) {
        getErrorReporter().error(loc, Messages.ERR_NO_ENUM_FACET);
        return null;
    }
    // use the name of the simple type as the name of the class.
    CClassInfoParent scope;
    if (type.isGlobal())
        scope = new CClassInfoParent.Package(getClassSelector().getPackage(type.getTargetNamespace()));
    else
        scope = getClassSelector().getClassScope();
    CEnumLeafInfo xducer = new CEnumLeafInfo(model, BGMBuilder.getName(type), scope, className, baseDt, memberList, type, builder.getBindInfo(type).toCustomizationList(), loc);
    xducer.javadoc = javadoc;
    BIConversion conv = new BIConversion.Static(type.getLocator(), xducer);
    conv.markAsAcknowledged();
    // attach this new conversion object to this simple type
    // so that successive look up will use the same object.
    builder.getOrCreateBindInfo(type).addDecl(conv);
    return conv.getTypeUse(type);
}

Example 2 with JavadocEscapeWriter

use of com.sun.codemodel.util.JavadocEscapeWriter in project jaxb-ri by eclipse-ee4j.

the class ClassSelector method addSchemaFragmentJavadoc.

/**
 * Copies a schema fragment into the javadoc of the generated class.
 */
private void addSchemaFragmentJavadoc(CClassInfo bean, XSComponent sc) {
    // first, pick it up from <documentation> if any.
    String doc = builder.getBindInfo(sc).getDocumentation();
    if (doc != null)
        append(bean, doc);
    // then the description of where this component came from
    Locator loc = sc.getLocator();
    String fileName = null;
    if (loc != null) {
        fileName = loc.getPublicId();
        if (fileName == null)
            fileName = loc.getSystemId();
    }
    if (fileName == null)
        fileName = "";
    String lineNumber = Messages.format(Messages.JAVADOC_LINE_UNKNOWN);
    if (loc != null && loc.getLineNumber() != -1)
        lineNumber = String.valueOf(loc.getLineNumber());
    String componentName = sc.apply(new ComponentNameFunction());
    String jdoc = Messages.format(Messages.JAVADOC_HEADING, componentName, fileName, lineNumber);
    append(bean, jdoc);
    // then schema fragment
    StringWriter out = new StringWriter();
    out.write("<pre>\n");
    SchemaWriter sw = new SchemaWriter(new JavadocEscapeWriter(out));
    sc.visit(sw);
    out.write("</pre>");
    append(bean, out.toString());
}