Update of 
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2059

Added Files:
        TapestryAsset.java TapestryBeanTag.java 
        TapestryBindingTag.java TapestryComponentSpecificationTag.java 
        TapestryComponentTag.java TapestryInjectTag.java 
        TapestryPageSpecificationTag.java TapestryParameterTag.java 
        TapestryPropertyTag.java TapestrySetTag.java 
Log Message:
Initial commit of Tapestry plugin for xdoclet2

--- NEW FILE: TapestryParameterTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Contained by: component-specification
 * Defines a formal parameter for the component.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryParameterTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * A unique name for the parameter.
     * @qtags.required
     */
    String getName_();

    /**
     * If yes, then the parameter must be bound. If no (the default),
     * then the parameter is optional.
     */
    String getRequired();

    /**
     * The name to use, instead of the parameter name, for the
     * JavaBean property connected to this parameter.
     */
    String getProperty();

    /**
     * Specifies the default value for the parameter, if not bound,
     * as a binding reference.
     */
    String getDefaultValue();

    /**
     * The default binding type for parameters (when a binding
     * is specified without a parameter).
     */
    String getDefaultBinding();

    /**
     * If true (the default), then the parameter property will cache the 
binding value
     * If false, then each access to the property will re-acquire the the 
current value
     * for the binding on each access (though invariant bindings may still be 
cached).
     */
    String getCache();

    /**
     * An optional, comma-seperated list of aliases for the parameter. Used to 
allow
     * compatibility when parameter names are changed.
     */
    String getAliases();

    /**
     * If true, then using the parameter will generate a runtime warning.
     */
    String getDeprecated();
}
--- NEW FILE: TapestryBeanTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Appears in: component-specification, page-specification
 * Defines a JavaBean that will be used in some way by the component.  Beans
 * are accessible via the components' beans property (which contains a property
 * for each bean).  Beans are created as needed, and are discarded based on
 * the lifecycle attribute.  Beans are typically used to extend the
 * implementation of a component via aggregation.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryBeanTag extends com.thoughtworks.qdox.model.DocletTag {
    /**
     * The description of the bean.
     */
    String getDescription();

    /**
     * The name of the bean.
     * @qtags.required
     */
    String getName_();

    /**
     * The Java class to instantiate.
     */
    String getClass_();

    /**
     * when the reference to the bean should be discard
     * @qtags.allowed-value none
     * @qtags.allowed-value request
     * @qtags.allowed-value page
     * @qtags.allowed-value render
     * @qtags.default request
     */
    String getLifecycle();

    /**
     * if specified, then a read-ony property is created in the component
     * to access the bean.
     */
    String getProperty();
}
--- NEW FILE: TapestryComponentTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Contained by: component-specification, page-specification
 * Defines a component contained by the component being specified.
 *
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryComponentTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * A unique identifier for the component within the container.
     * @qtags.required
     */
    String getId();

    /**
     * The type of component, either a well known logical name, or the complete 
path
     * to the component's specification.
     * @qtags.required
     */
    String getType();

    /**
     * The id of a previously defined component; this component will be a copy
     * of the other component.
     */
    String getCopyOf();

    /**
     * If yes, then all informal parameters of the containing
     * component are copied into this component.
     */
    String getInheritInformalParameters();

    /**
     * Optional property name; the component instance will be injected into this
     * property.
     */
    String getProperty();
}
--- NEW FILE: TapestryPageSpecificationTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Declares the class as a Tapestry Page
 * @qtags.location class
 * @qtags.unique
 * @author Paolo Donà
 */
public interface TapestryPageSpecificationTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The page description.
     */
    String getDescription();
}
--- NEW FILE: TapestryAsset.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Contained by: component-specification, page-specification
 *
 * An asset that may be referenced by the component. Different prefixes
 * may be applied to the path indicate where the asset is stored;
 * context: for the web application context folder or classpath:
 * for a file stored in the web applications' classpath.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryAsset extends com.thoughtworks.qdox.model.DocletTag {
    /**
     * The name of the bean.
     * @qtags.required
     */
    String getName_();

    /**
     * The path for the resource, which may be relative or absolute.
     * usually starts with "context:" or "classpath:"
     * @qtags.required
     */
    String getPath();

    /**
     * if specified, then a read-ony property is created in the component
     * to access the asset.
     */
    String getProperty();
}
--- NEW FILE: TapestryPropertyTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Contained by: component-specification, page-specification
 * Identifies a transient or persistent property.
 * obtained from HiveMind.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryPropertyTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The name of the property.
     * @qtags.required
     */
    String getName_();

    /**
     * The name of the strategy for persisting the property between requests,
     * or leave blank for no persistence (that is, a transient property).
     * "session" is the most common strategy.
     */
    String getPersist();

    /**
     * If provided, this is an OGNL expression used
     * to initialize the property.
     */
    String getInitialValue();
}
--- NEW FILE: TapestryComponentSpecificationTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Declares the class as a Tapestry Component
 * It's attributes define whether the component may wrap other elements, and 
whether
 * informal (undeclared) parameters are allowed.  Very similar to a 
page-specification,
 * except that component-specification allows for parameters (formal and 
informal).
 *
 * @qtags.location class
 * @qtags.unique
 * @author Paolo Donà
 */
public interface TapestryComponentSpecificationTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The page description.
     */
    String getDescription();

    /**
     * If yes (the default), the component may wrap other elements (have a 
body).
     * @qtags.allowed-value yes
     * @qtags.allowed-value no
     */
    String getAllowBody();

    /**
     * If yes (the default), informal parameters (parameters that are not 
explictily defined) are allowed.
     * @qtags.allowed-value yes
     * @qtags.allowed-value no
     */
    String getAllowInformalParameters();

    /**
     * If yes, then using the component will generate a warning,
     * advising the user to find a different component. The default is no.
     * @qtags.allowed-value yes
     * @qtags.allowed-value no
     */
    String getDeprecated();
}
--- NEW FILE: TapestryBindingTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Appears in: component
 * Binds a parameter of the component to a value. The value may
 * be literal, an OGNL expression, or something else, as
 * determined by its prefix.
 *
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryBindingTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * The name of the property to be set.
     * @qtags.required
     */
    String getName_();

    /**
     * The value (as a binding reference) to set the property to.
     * @qtags.required
     */
    String getValue_();

    /**
     * The id of the component the binding belongs to.
     * @qtags.required
     */
    String getComponentId();
}
--- NEW FILE: TapestryInjectTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Contained by: component-specification, page-specification
 * Defines a new property whose read-only value is an object
 * obtained from HiveMind.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestryInjectTag extends 
com.thoughtworks.qdox.model.DocletTag {
    /**
     * property The name of the property.
     * @qtags.required
     */
    String getProperty();

    /**
     * The type of object to be injected, used to interpret the meaning of the 
object attribute.
     */
    String getType();

    /**
     * The locator used to obtain the value
     * @qtags.required
     */
    String getObject();
}
--- NEW FILE: TapestrySetTag.java ---
/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.tapestry.qtags;

/**
 * Appears in: bean
 * Used to initialize a property of a managed bean.  The value
 * is a binding reference, and is provided as the value attribute,
 * or as wrapped character data.
 * @qtags.location class
 * @author Paolo Donà
 */
public interface TapestrySetTag extends com.thoughtworks.qdox.model.DocletTag {
    /**
     * The name of the property to be set.
     * @qtags.required
     */
    String getName_();

    /**
     * The value (as a binding reference) to set the property to.
     * @qtags.required
     */
    String getValue_();

    /**
     * The name of the bean the property belongs to.
     * @qtags.required
     */
    String getBeanName();
}


-------------------------------------------------------
SF.Net email is Sponsored by the Better Software Conference & EXPO
September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices
Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf
_______________________________________________
xdoclet-plugins-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits

Reply via email to