property-types.xsl revision 6df5dcb0909ce8efb1aefa7a237a705e14de1f0b
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
! add the following below this CDDL HEADER, with the fields enclosed
! by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
!
! Portions Copyright 2007 Sun Microsystems, Inc.
! -->
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!--
WARNING: when new property types are defined, they must be
included here.
These stylesheets are included and NOT imported so that they
have the same import precedence as the default rules.
-->
<!--
Default rules applicable to each property type.
Property type stylesheets should override these where necessary.
-->
<!--
Get the Java object-based type associated with a property syntax.
By default property values are represented using strings.
-->
<xsl:template match="*" mode="java-value-type">
<xsl:value-of select="'String'" />
</xsl:template>
<!--
Get the Java primitive type, if applicable, associated with a
property syntax.
By default property values are represented using the type defined by
java-value-type.
-->
<xsl:template match="*" mode="java-value-primitive-type">
<xsl:apply-templates select="." mode="java-value-type" />
</xsl:template>
<!--
Generate import elements represesenting the import statements
required by values of the property.
By default property values are represented using strings which
don't require an import statement - so do nothing.
-->
<xsl:template match="*" mode="java-value-imports" />
<!--
Generate the Java definition type used to define the property.
By default properties are defined using string property
definitions.
-->
<xsl:template match="*" mode="java-definition-type">
<xsl:value-of select="'StringPropertyDefinition'" />
</xsl:template>
<!--
Generate import elements represesenting the import statements
required by the property's definition and its values.
By default assume that the definition type is in
org.opends.server.admin and is derived directly from the
java-definition-type (might not be the case for parameterized
types. In addition pull in the value imports.
-->
<xsl:template match="*" mode="java-definition-imports">
<xsl:element name="import">
<xsl:apply-templates select="." mode="java-definition-type" />
</xsl:element>
<xsl:apply-templates select="." mode="java-value-imports" />
</xsl:template>
<!--
If the property definition is generic, get the generic type. Otherwise,
do nothing.
Default: do nothing.
-->
<xsl:template match="*" mode="java-definition-generic-type" />
<!--
Generate property definition specific constructor setters.
By default, do nothing.
-->
<xsl:template match="*" mode="java-definition-ctor" />
<!--
Generate property definition specific post-construction code.
By default, do nothing.
-->
<xsl:template match="*" mode="java-definition-post-ctor" />
<!--
Wrapper templates which can be called directly instead of
requiring the more indirect and less readable apply-templates
mechanism.
-->
<!--
Get the Java imports required for a property's values.
-->
<xsl:template name="get-property-java-imports">
<xsl:apply-templates select="adm:syntax/*"
mode="java-value-imports" />
</xsl:template>
<!--
Get the Java imports required for a property's definition.
-->
<xsl:template name="get-property-definition-java-imports">
<xsl:apply-templates select="adm:syntax/*"
mode="java-definition-imports" />
</xsl:template>
<!--
Get the Java object-based type associated with a property syntax.
-->
<xsl:template name="get-property-java-type">
<xsl:apply-templates select="adm:syntax/*" mode="java-value-type" />
</xsl:template>
<!--
Get the Java primitive type, if applicable, associated with a
property syntax.
-->
<xsl:template name="get-property-java-primitive-type">
<xsl:apply-templates select="adm:syntax/*"
mode="java-value-primitive-type" />
</xsl:template>
<!--
Get the property definition type associated with a
property syntax.
-->
<xsl:template name="get-property-definition-type">
<xsl:apply-templates select="adm:syntax/*"
mode="java-definition-type" />
</xsl:template>
<!--
If the property definition is generic, get the generic type. Otherwise,
do nothing.
-->
<xsl:template name="get-property-definition-generic-type">
<xsl:apply-templates select="adm:syntax/*"
mode="java-definition-generic-type" />
</xsl:template>
<!--
Generate property definition specific constructor setters.
-->
<xsl:template name="get-property-definition-ctor">
<xsl:apply-templates select="adm:syntax/*"
mode="java-definition-ctor" />
</xsl:template>
<!--
Generate property definition specific post-construction code.
-->
<xsl:template name="get-property-definition-post-ctor">
<xsl:apply-templates select="adm:syntax/*"
mode="java-definition-post-ctor" />
</xsl:template>
<!--
Generate the property getter declarations.
-->
<xsl:template name="generate-property-getter-declaration">
<xsl:param name="interface" select="/.." />
<xsl:variable name="name" select="@name" />
<xsl:variable name="java-property-name">
<xsl:call-template name="name-to-java">
<xsl:with-param name="value" select="$name" />
</xsl:call-template>
</xsl:variable>
<xsl:value-of
select="concat(' /**
',
' * Get the "', $name,'" property.
')" />
<xsl:if test="adm:synopsis">
<xsl:value-of select="' * <p>
'" />
<xsl:call-template name="add-java-comment">
<xsl:with-param name="indent-text" select="' *'" />
<xsl:with-param name="content" select="adm:synopsis" />
</xsl:call-template>
</xsl:if>
<xsl:if test="adm:description">
<xsl:value-of select="' * <p>
'" />
<xsl:call-template name="add-java-comment">
<xsl:with-param name="indent-text" select="' *'" />
<xsl:with-param name="content" select="adm:description" />
</xsl:call-template>
</xsl:if>
<xsl:choose>
<xsl:when test="string(@multi-valued) != 'true'">
<xsl:value-of
select="concat(' *
',
' * @return Returns the value of the "', $name,'" property.
',
' */
')" />
<xsl:value-of select="' '" />
<xsl:choose>
<!--
The method is guaranteed to return a value since there is a
well-defined default value.
-->
<xsl:call-template name="get-property-java-primitive-type" />
</xsl:when>
<xsl:when
test="$interface = 'server' and @mandatory = 'true'">
<!--
The method is guaranteed to return a value in the server interface, but
not necessarily in the client, since the mandatory property might not
have been created yet.
-->
<xsl:call-template name="get-property-java-primitive-type" />
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="get-property-java-type" />
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:otherwise>
<xsl:value-of
select="concat(' *
',
' * @return Returns the values of the "', $name,'" property.
',
' */
')" />
<xsl:value-of select="' SortedSet<'" />
<xsl:call-template name="get-property-java-type" />
<xsl:value-of select="'>'" />
</xsl:otherwise>
</xsl:choose>
<xsl:choose>
<xsl:value-of select="' is'" />
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="' get'" />
</xsl:otherwise>
</xsl:choose>
<xsl:value-of
select="concat($java-property-name,
'();
')" />
</xsl:template>
<!--
Generate the property setter declarations.
-->
<xsl:template name="generate-property-setter-declaration">
<xsl:if test="not(@monitoring='true')">
<xsl:variable name="name" select="@name" />
<xsl:variable name="java-property-name">
<xsl:call-template name="name-to-java">
<xsl:with-param name="value" select="$name" />
</xsl:call-template>
</xsl:variable>
<xsl:value-of
select="concat(' /**
',
' * Set the "', $name, '" property.
')" />
<xsl:if test="adm:synopsis">
<xsl:value-of select="' * <p>
'" />
<xsl:call-template name="add-java-comment">
<xsl:with-param name="indent-text" select="' *'" />
<xsl:with-param name="content" select="adm:synopsis" />
</xsl:call-template>
</xsl:if>
<xsl:if test="adm:description">
<xsl:value-of select="' * <p>
'" />
<xsl:call-template name="add-java-comment">
<xsl:with-param name="indent-text" select="' *'" />
<xsl:with-param name="content" select="adm:description" />
</xsl:call-template>
</xsl:if>
<xsl:if test="@read-only='true'">
<xsl:value-of select="' * <p>
'" />
<xsl:value-of
select="concat(
' * This property is read-only and can only be modified during
',
' * creation of a ', $this-ufn, '.
')" />
</xsl:if>
<xsl:choose>
<xsl:when test="not(@multi-valued='true')">
<xsl:value-of
select="concat(' *
',
' * @param value The value of the "', $name, '" property.
',
' * @throws IllegalPropertyValueException
',
' * If the new value is invalid.
')" />
<xsl:if test="@read-only='true'">
<xsl:value-of
select="concat(
' * @throws PropertyIsReadOnlyException
',
' * If this ', $this-ufn, ' is not being initialized.
')" />
</xsl:if>
<xsl:value-of
select="concat(
' */
',
' void set', $java-property-name, '(')" />
<xsl:choose>
<xsl:when test="@mandatory = 'true'">
<xsl:call-template
name="get-property-java-primitive-type" />
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="get-property-java-type" />
</xsl:otherwise>
</xsl:choose>
<xsl:value-of select="' value'" />
</xsl:when>
<xsl:otherwise>
<xsl:value-of
select="concat(' *
',
' * @param values The values of the "', $name, '" property.
',
' * @throws IllegalPropertyValueException
',
' * If one or more of the new values are invalid.
')" />
<xsl:if test="@read-only='true'">
<xsl:value-of
select="concat(
' * @throws PropertyIsReadOnlyException
',
' * If this ', $this-ufn, ' is not being initialized.
')" />
</xsl:if>
<xsl:value-of
select="concat(
' */
',
' void set', $java-property-name, '(Collection<')" />
<xsl:call-template name="get-property-java-type" />
<xsl:value-of select="'> values'" />
</xsl:otherwise>
</xsl:choose>
<xsl:value-of select="') throws IllegalPropertyValueException'" />
<xsl:if test="@read-only='true'">
<xsl:value-of select="', PropertyIsReadOnlyException'" />
</xsl:if>
<xsl:value-of select="';
'" />
</xsl:if>
</xsl:template>
</xsl:stylesheet>