elte.java2_utikalauz5.programok
TagletTeszt osztály

java.lang.Object
  elte.java2_utikalauz5.programok.TagletTeszt

Megvalósított interfészek:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet

public class TagletTeszt
extends Object
implements com.sun.tools.doclets.Taglet, com.sun.tools.doclets.internal.toolkit.taglets.Taglet

Forrásfájlok megtekintését, valamint egyéb fájlok letöltését biztosító taglet. Forrásfájl megadása a @link.forrásfájl, letöltendő fájl megadása pedig a @link.letöltés új dokumentációs blokkleíró elemekkel történik, melyek feldolgozását ez a javadoc taglet végzi.

Az elemek szintaxisa a következő:

@link.forrásfájl URL forrásfájlnév
további opcionális magyarázó szöveg.

@link.letöltés URL fájlnév
további opcionális magyarázó szöveg.

Mióta:

Java 2 Útikalauz programozóknak 5.0

Forrásfájl:

TagletTeszt.java

Letöltés:

TagletTeszt.jar

Mezők

private String	cél A hivatkozás megjelenítéséhez használt cél neve.
private String	elemnév A feldolgozandó dokumentációs blokkleíró elem neve.

Konstruktorok

TagletTeszt(String elemnév, String cél)
Taglet konstruktor.

Metódusok

String	getName() Megadja a kezelt dokumentációs elem nevét.
com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput	getTagletOutput(com.sun.javadoc.Doc elemek, com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter kimenet) Direkt taglet dokumentációs elemeket kezelő metódusa.
com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput	getTagletOutput(com.sun.javadoc.Tag elem, com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter kimenet) Direkt taglet dokumentációs elemet kezelő metódusa.
boolean	inConstructor() Megadja, hogy a kezelt elem használható-e konstruktorok leírásában.
boolean	inField() Megadja, hogy a kezelt elem használható-e mezők dokumentációs leírásában.
boolean	inMethod() Megadja, hogy a kezelt elem használható-e metódusok leírásában.
boolean	inOverview() Megadja, hogy a kezelt elem használható-e az áttekintő leírásban.
boolean	inPackage() Megadja, hogy a kezelt elem használható-e csomagok dokumentációs leírásában.
boolean	inType() Megadja, hogy a kezelt elem használható-e típusok dokumentációs leírásában.
boolean	isInlineTag() Megadja, hogy a kezelt elem beágyazható dokumentációs elem-e.
static void	register(Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletek) Saját tagletek regisztrálása.
private static void	regisztrálás(String elemnév, String cél, Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletek) Adott blokkleíró elemet kezelő taglet regisztrálása.
private String	toHTML(String elem) Dokumentációs elem szövegének alapján HTML generálása.
String	toString(com.sun.javadoc.Tag elem) Hagyományos taglet dokumentációs elemet kezelő metódusa.
String	toString(com.sun.javadoc.Tag[] elemek) Hagyományos taglet dokumentációs elemeket kezelő metódusa.

java.lang.Object osztálytól örökölt metódusok

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Mezők részletezése

elemnév

private final String elemnév

A feldolgozandó dokumentációs blokkleíró elem neve.

cél

private final String cél

A hivatkozás megjelenítéséhez használt cél neve.

Konstruktorok részletezése

TagletTeszt

public TagletTeszt(String elemnév,
                   String cél)

Taglet konstruktor.

Paraméterek:

elemnév - A feldolgozandó dokumentációs blokkleíró elem neve.

cél - A hivatkozás megjelenítéséhez használt cél neve.

Metódusok részletezése

getName

public String getName()

Megadja a kezelt dokumentációs elem nevét.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész getName metódusát

Visszaadott érték:

A kezelt dokumentációs elem neve.

inField

public boolean inField()

Megadja, hogy a kezelt elem használható-e mezők dokumentációs leírásában.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inField metódusát

Visszaadott érték:

Hamisat ad vissza, mert nem használható mezők leírásában.

inConstructor

public boolean inConstructor()

Megadja, hogy a kezelt elem használható-e konstruktorok leírásában.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inConstructor metódusát

Visszaadott érték:

Hamisat ad vissza, mert nem használható konstruktorok leírásában.

inMethod

public boolean inMethod()

Megadja, hogy a kezelt elem használható-e metódusok leírásában.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inMethod metódusát

Visszaadott érték:

Hamisat ad vissza, mert nem használható metódusok leírásában.

inOverview

public boolean inOverview()

Megadja, hogy a kezelt elem használható-e az áttekintő leírásban.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inOverview metódusát

Visszaadott érték:

Hamisat ad vissza, mert nem használható az áttekintő leírásban.

inPackage

public boolean inPackage()

Megadja, hogy a kezelt elem használható-e csomagok dokumentációs leírásában.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inPackage metódusát

Visszaadott érték:

Igazat ad vissza, mert használható csomagok leírásában.

inType

public boolean inType()

Megadja, hogy a kezelt elem használható-e típusok dokumentációs leírásában.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész inType metódusát

Visszaadott érték:

Igazat ad vissza, mert használható interfészek leírásában.

isInlineTag

public boolean isInlineTag()

Megadja, hogy a kezelt elem beágyazható dokumentációs elem-e.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész isInlineTag metódusát

Visszaadott érték:

Hamisat ad vissza, mert blokkleíró elemeket kezelünk.

regisztrálás

private static void regisztrálás(String elemnév,
                                 String cél,
                                 Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletek)

Adott blokkleíró elemet kezelő taglet regisztrálása.

Paraméterek:

elemnév - A feldolgozandó dokumentációs blokkleíró elem neve.

cél - A hivatkozás megjelenítéséhez használt cél neve.

tagletek - A tagletek bejegyzéseinek regisztrációja.

register

public static void register(Map<String,com.sun.tools.doclets.internal.toolkit.taglets.Taglet> tagletek)

Saját tagletek regisztrálása.

Paraméterek:

tagletek - A tagletek bejegyzéseinek regisztrációja.

toString

public String toString(com.sun.javadoc.Tag elem)

Hagyományos taglet dokumentációs elemet kezelő metódusa.

Paraméterek:

elem - Az aktuális dokumentációs elem tartalma.

Visszaadott érték:

A kapott dokumentációs elem feldolgozásának eredménye HTML formában.

toString

public String toString(com.sun.javadoc.Tag[] elemek)

Hagyományos taglet dokumentációs elemeket kezelő metódusa.

Paraméterek:

elemek - Az aktuális dokumentációs elemek tartalma.

Visszaadott érték:

A kapott elemek feldolgozásának eredménye HTML formában.

getTagletOutput

public com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput getTagletOutput(com.sun.javadoc.Tag elem,
                                                                                   com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter kimenet)

Direkt taglet dokumentációs elemet kezelő metódusa.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész getTagletOutput metódusát

Paraméterek:

elem - Az aktuális dokumentációs elem tartalma.

kimenet - A taglet kimeneti kapcsolata.

Visszaadott érték:

A kapott dokumentációs elem feldolgozásának eredménye HTML formában.

getTagletOutput

public com.sun.tools.doclets.internal.toolkit.taglets.TagletOutput getTagletOutput(com.sun.javadoc.Doc elemek,
                                                                                   com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter kimenet)

Direkt taglet dokumentációs elemeket kezelő metódusa.

Megvalósítja:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet interfész getTagletOutput metódusát

Paraméterek:

elemek - Az aktuális dokumentációs elemek tartalma.

kimenet - A taglet kimeneti kapcsolata.

Visszaadott érték:

A kapott elemek feldolgozásának eredménye HTML formában.

toHTML

private String toHTML(String elem)

Dokumentációs elem szövegének alapján HTML generálása.

Paraméterek:

elem - Az aktuális dokumentációs elem szövegtartalma.

Visszaadott érték:

A tartalom feldolgozásának eredménye HTML formában.