Dokumentumkezelő kisalkalmazások használata J2C alkalmazásokban

J2C alkalmazások Java forráskódjához címkéket hozzáadva a J2C dokumentumkezelő kisalkalmazás funkcionalitás kiaknázása lehetővé válik.

A dokumentumkezelő kisalkalmazás címkék olyan jegyzet jellegű programozási címkék, amelyek bővíthető feldolgozási mechanizmust biztosítanak J2EE környezetben telepíthető alkalmazás műtermékek előállításához. Ha a J2C alkalmazás Java forráskódjához dokumentumkezelő kisalkalmazás címkéket ad hozzá, akkor ezek a műtermékek automatikusan előállításra kerülnek (miután a CTRL-S billentyűkombináció lenyomásával menti a kódot).
A dokumentumkezelő kisalkalmazás címkék a Java forrásba Javadoc-stílusú megjegyzésként kerülnek beszúrásra. A jegyzet-alapú programozási címkék attribútumai közé tartozik a Hatókör (hol található a címke a kódon belül) és a Multiplicitás (milyen gyakran használható az adott címke).

Támogatott dokumentumkezelő kisalkalmazás címkék:

J2C alkalmazások fejlesztésekor a következő típusú, a Java forráskódhoz adható címkék állnak rendelkezésre:
  • J2C címkék
  • Típus leíró címkék:

Dokumentumkezelő kisalkalmazás címke attribútumok

  1. Hatókör: A hatókör a címkék helyére utal a Java forrásfájlon belül. Érvényes hatókör beállítások a csomag, osztály, metódus és mező.
    • Csomag

      A csomag megjegyzéshez kerül hozzáadásra. Ez a hatókör az egész Java csomagra, a modulra. illetve az alkalmazásra, mint egészre vonatkozó információkat biztosít.

    • Osztály

      Az osztály megjegyzéshez kerül hozzáadásra. Ez a hatókör a Java típusról vagy felületről, mint egészről biztosít információkat.

    • Metódus

      Az osztályon belül adott metódus megjegyzéseihez kerül hozzáadásra. Ez a hatókör az osztályon belül a hivatkozott metódusról biztosít információkat.

    • Mező

      Az osztályon belül adott mező megjegyzéseihez kerül hozzáadásra. Ez a hatókör az osztályon belül a hivatkozott mezőről biztosít információkat.

  2. Multiplicitás: A multiplicitás arra a számra utal, ahányszor adott címke egy Java forrásfájlban megjelenhet. A dokumentumkezelő kisalkalmazás jelölésmódban a multiplicitás a címke neve után zárójelek között jelenik meg
    • 0..1: azt jelzi, hogy a címke 0 vagy 1 alkalommal használható Java forrásfájlban.
    • 0..n: azt jelzi, hogy a címke nullától végtelen számú alkalommal használható Java forrásfájlban.
Példa: A következő példa az IMS több-részes kimenet című ismertetőből származik:
  1. A Projektböngésző nézetben bontsa ki a projektet, bontsa ki a Java erőforrások lehetőséget, majd bontsa ki a JavaSource részt.
  2. Kattintson a jobb egérgombbal a csomagra (ebben az esetben sample.ims), majd az Új osztály varázsló indításához válassza az előugró menü Új > Osztály menüpontját.
  3. Az osztály neveként írja be a CCIBuffer kifejezést. Fogadjon el minden alapértelmezett beállítást.
  4. Kattintson a Befejezés gombra és a CCIBuffer osztály a Java-szerkesztőben megnyílik.
  5. A CCIBuffer osztály megjegyzés szakaszához adja hozzá a @type-descriptor.message-buffer címkét a következő módon:

    Dokumentumkezelő kisalkalmazás címke hozzáadása

  6. A módosítások mentéséhez nyomja meg a CTRL-S billentyűkombinációt. A CCIBuffer.java osztályfájlban a következő kód automatikusan előállításra kerül:
    /*
     * Létrehozva 2004. október 13-án
     *
     * TODO Jelen előállított fájl sablonjának módosításához ugorjon az
     * Ablak - Beállítások - Java - Kódstílus - Kódsablonok lehetőségre
     */
    package sample.ims;
    
    /**
     * @author ivyho
     *
     * TODO Jelen előállított típus megjegyzés sablonjának módosításához ugorjon az
     * Ablak - Beállítások - Java - Kódstílus - Kódsablonok lehetőségre
     * @type-descriptor.message-buffer
     */
    public class CCIBuffer implements javax.resource.cci.Record,
    		javax.resource.cci.Streamable, com.ibm.etools.marshall.RecordBytes {
    
    	private byte[] buffer_ = null;
    
    	/**
    	 * @generated
    	 */
    	public CCIBuffer() {
    		return;
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#getRecordShortDescription()
    	 */
    	public String getRecordShortDescription() {
    		return (this.getClass().getName());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#hashCode()
    	 */
    	public int hashCode() {
    		return (super.hashCode());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Streamable#write(OutputStream)
    	 */
    	public void write(java.io.OutputStream outputStream)
    			throws java.io.IOException {
    		outputStream.write(buffer_);
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#setRecordShortDescription(String)
    	 */
    	public void setRecordShortDescription(String shortDescription) {
    		return;
    	}
    
    	/**
    	 * @generated
    	 */
    	public int getSize() {
    		if (buffer_ != null)
    			return (buffer_.length);
    		else
    			return (0);
    	}
    
    	/**
    	 * @generated
    	 * @see java.lang.Object#toString
    	 */
    	public String toString() {
    		StringBuffer sb = new StringBuffer(super.toString());
    		sb.append("\n");
    		com.ibm.etools.marshall.util.ConversionUtils.dumpBytes(sb, buffer_);
    		return (sb.toString());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#getRecordName()
    	 */
    	public String getRecordName() {
    		return (this.getClass().getName());
    	}
    
    	/**
    	 * @generated
    	 */
    	public byte[] getBytes() {
    		return (buffer_);
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#clone()
    	 */
    	public Object clone() throws CloneNotSupportedException {
    		return (super.clone());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#setRecordName(String)
    	 */
    	public void setRecordName(String recordName) {
    		return;
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#equals()
    	 */
    	public boolean equals(Object object) {
    		return (super.equals(object));
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Streamable#read(InputStream)
    	 */
    	public void read(java.io.InputStream inputStream)
    			throws java.io.IOException {
    		byte[] input = new byte[inputStream.available()];
    		inputStream.read(input);
    		buffer_ = input;
    	}
    
    	/**
    	 * @generated
    	 */
    	public void setBytes(byte[] bytes) {
    		buffer_ = bytes;
    	}
    
    }

Visszajelzés