Gyorsjavítás feldolgozó

Azonosító:

Minimális verziószám:

Leírás:

A 3.2-es verzió óta a kiterjesztések megadhatják, mely problémajelző típusokat képesek kezelni. Csak az ilyen típusú problémákat kapják meg feldolgozásra. Ha nincs megadva kezelt jelzőtípus, akkor a feldolgozó csak org.eclipse.wst.jsdt.core.problem, org.eclipse.wst.jsdt.core.buildpath_problem és org.eclipse.wst.jsdt.core.task (a 3.2-es változat előtti viselkedéssel kompatibilis) típusú problémákat kap.

Ez a kiterjesztési pont támogatja az enablement címkét. A tesztelhető tulajdonságok:

compilationUnit: ICompilationUnit típus; a fordítási egység, amire a gyorssegéd alkalmazva van

projectNatures: Collection típus; az aktuális projekt összes projektjellege

sourceLevel: String típus; az aktuális projekt forrásmegfelelése

Konfigurációs kód:

<!ELEMENT extension (quickFixProcessor+)>

<w!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

• point - a cél kiterjesztési pont teljes képzésű azonosítója
• id - a kiterjesztéspéldány elhagyható azonosítója
• name - a kiterjesztéspéldány elhagyható neve

<!ELEMENT quickFixProcessor (enablement? , handledMarkerTypes*)>

<!ATTLIST quickFixProcessor

id                  CDATA #REQUIRED

name                CDATA #IMPLIED

class               CDATA #REQUIRED

requiredSourceLevel CDATA #IMPLIED

• id - a gyorsjavítás feldolgozó egyedi azonosítója
• name - a gyorsjavítás feldolgozó honosított neve
• class - a gyorsjavítás feldolgozót megvalósító osztály neve. Az osztálynak nyilvánosnak kell lennie és meg kell valósítania az org.eclipse.wst.jsdt.ui.text.java.IQuickFixProcessor felületet egy nyilvános argumentum nélküli konstruktorral.
• requiredSourceLevel - elhagyható attribútum, a feldolgozó által megkövetelt minimális forrásmegfelelést adja meg

<!ELEMENT handledMarkerTypes (markerType+)>

Megadja azon problémák jelzőtípusait, melyeket ez a gyorsjavítás feldolgozó kezelni tud. Ha nincs megadva kezelt jelzőtípus, akkor a feldolgozó az org.eclipse.wst.jsdt.core.problem, org.eclipse.wst.jsdt.core.buildpath_problem és org.eclipse.wst.jsdt.core.task típusú problémákat kapja meg.

<!ELEMENT markerType EMPTY>

<!ATTLIST markerType

id CDATA #REQUIRED

• id - a jelző jelző típusú azonosítója, amelyet a feldolgozó képes kezelni

<!ELEMENT enablement (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

Általános gyökérelem. Az elem kiterjesztési pontokon belül használható a hozzá tartozó enablement kifejezés meghatározására. Az enablement kifejezések leszármazottai az "and" operátorral kombinálhatók.

<!ELEMENT not (not | and | or | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate | reference)>

Ez az elem egy NOT műveletet képvisel a részelemeként kiértékelt kifejezés eredményén.

<!ELEMENT and (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

Ez az elem egy AND műveletet képvisel a részelemeként kiértékelt összes kifejezés eredményén.

<!ELEMENT or (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

Ez az elem egy OR műveletet képvisel a részelemeként kiértékelt összes kifejezés eredményén.

<!ELEMENT instanceof EMPTY>

<!ATTLIST instanceof

value CDATA #REQUIRED

Ezzel az elemmel végezhető el a fókuszban lévő objektum instanceof ellenőrzése. A kifejezés az EvaluationResult.TRUE értékkel tér vissza, ha az objektum típusa a value attribútumban megadott típus altípusa. Ellenkező esetben EvaluationResult.FALSE kerül visszaadásra.

• value - Egy osztály vagy felület teljes képzésű neve.

<!ELEMENT test EMPTY>

<!ATTLIST test

property              CDATA #REQUIRED

args                  CDATA #IMPLIED

value                 CDATA #IMPLIED

forcePluginActivation (true | false)

Ezzel az elemmel értékelhető ki a fókuszban lévő objektum tulajdonságának állapota. A tesztelhető tulajdonságok halmaza az org.eclipse.core.expressions.propertyTesters kiterjesztési ponton terjeszthető ki. A tesztelési kifejezés EvaluationResult.NOT_LOADED értéket ad vissza, ha a tényleges tesztelést végző tulajdonságtesztelő még nincs betöltve és a forcePluginActivation attribútum értéke hamis. Ha a forcePluginActivation értéke true és a kiértékelési kontextus kiértékeli a kifejezéstámogatási bedolgozó tevékenységet, akkor a tulajdonság kiértékelése a vizsgálót meghatározó bedolgozó aktiválását eredményezi.

• property - egy objektum megvizsgálandó tulajdonságának neve.
• args - a tulajdonságtesztelőnek átadandó további argumentumok. Több argumentum esetén ezeket vesszővel kell elválasztani egymástól. Az egyes argumentumok a tesztkifejezés value attribútumára vonatkozóan meghatározott szabályok szerint kerülnek átalakításra Java alaptípussá.
• value - a tulajdonság várt értéke. Kihagyható, ha a tulajdonság logikai tulajdonság. A tesztelési kifejezésnek EvaluationResult.TRUE értéket kell visszaadnia, ha a tulajdonság megegyezik az értékkel, egyébként pedig EvaluationResult.FALSE értéket. A value attribútum az alábbi szabályok szerint kerül átalakításra Java alaptípussá:
  • A "true" karaktersorozatból Boolean.TRUE lesz.
  • A "false" karaktersorozatból Boolean.FALSE lesz.
  • Ha a karaktersorozat pontot tartalmaz, akkor a parancsértelmező megkísérli Float objektummá alakítani az értéket. Ha ez meghiúsul, akkor a karaktersorozat java.lang.String típusként lesz kezelve.
  • Ha a karaktersorozat csak számokat tartalmaz, akkor az értelmező Integer objektummá alakítja az értéket.
  • A karaktersorozat minden más esetben java.lang.String objektumként lesz kezelve.
  • A karaktersorozat Boolean, Float vagy Integer objektummá alakítása a karaktersorozat egyszeres idézőjelek közé zárásával kerülhető el. A value="'true'" attribútumból például "true" karaktersorozat lesz.
• forcePluginActivation - jelző, amely megmutatja, hogy a tulajdonságvizsgálót kiegészítő bedolgozót szükséges-e betölteni. Ilyen módon a paramétert megfontoltan kell használni a szükségtelen bedolgozó-aktiválások elkerülésére. A legtöbb ügyfél számára kerülendő a paraméter beállítása true értékre. A paraméter csak akkor lesz figyelembe véve, ha a kifejezés kiértékeléséhez használt kiértékelési kontextus engedélyezi a bedolgozó aktiválást. Egyébként a paraméter figyelmen kívül marad, és nem történik bedolgozó aktiválás.

<!ELEMENT systemTest EMPTY>

<!ATTLIST systemTest

property CDATA #REQUIRED

value    CDATA #REQUIRED

Megvizsgál egy rendszertulajdonságot a System.getProperty metódus meghívásával, és összehasonlítja az eredményt a value attribútumban megadott értékkel.

• property - A megvizsgálandó rendszertulajdonság neve.
• value - a tulajdonság várt értéke. Az érték karaktersorozatként kerül értelmezésre.

<!ELEMENT equals EMPTY>

<!ATTLIST equals

value CDATA #REQUIRED

Ezzel az elemmel végezhető el a fókuszban lévő objektum egyenlőségi ellenőrzése. A kifejezés az EvaluationResult.TRUE értékkel tér vissza, ha az objektum egyenlő a value attribútumban megadott értékkel. Ellenkező esetben EvaluationResult.FALSE kerül visszaadásra.

• value - az elvárt érték. A karaktersorozatként megadott érték át lesz alakítva egy Java alaptípusra, a tesztkifejezés value attribútumánál használt szabályok szerint.

<!ELEMENT count EMPTY>

<!ATTLIST count

value CDATA #REQUIRED

Ezzel az elemmel vizsgálható megy egy kollekció elemszáma.

• value - a lista elemeinek számának meghatározására szolgáló kifejezés. A következő helyettesítő karakterek használhatók:

  *

  tetszőleges számú elem

  ?

  nincs elem vagy egy elem

  +

  legalább egy elem

  !

  nincs elem

  -N)

  kevesebb, mint N elem

  (N-

  több, mint N elem

  egész érték

  a listának pontosan ennyi számú elemet kell tartalmaznia

<!ELEMENT with (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST with

variable CDATA #REQUIRED

Az elem kicseréli a leszármazott elemek tekintetében megvizsgálandó objektumot az adott változó által hivatkozott objektumra. Ha a változó nem oldható fel, akkor a kifejezés a kiértékelés során ExpressionException kivételt ad. A with kifejezések leszármazottai az "and" operátorral kombinálhatók.

• variable - a további vizsgálathoz használandó változó neve. A kiterjesztési pont kiértékelőjének feladata, hogy a változót elérhetővé tegye a változókészletben.

<!ELEMENT resolve (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST resolve

variable CDATA #REQUIRED

args     CDATA #IMPLIED

Az elem kicseréli a leszármazott elemek tekintetében megvizsgálandó objektumot az adott változó által hivatkozott objektumra. Ha a változó nem oldható fel, akkor a kifejezés a kiértékelés során ExpressionException kivételt ad. A resolve kifejezések leszármazottai az "and" operátorral kombinálhatók.

• variable - a feloldandó változó neve. Ezek után ez a változó szolgál fókuszban lévő objektumként a leszármazott elemek kiértékeléséhez. A kiterjesztési pont kiértékelőjének feladata, hogy a kifejezés kiértékelésekor megfelelő változófeloldót biztosítson (lásd: IVariableResolver) a gyökér kifejezési elemnek átadott kiértékelési környezeten keresztül.
• args - a változófeloldónak átadandó további argumentumok. Több argumentum esetén ezeket vesszővel kell elválasztani egymástól. Az egyes argumentumok a tesztkifejezés value attribútumára vonatkozóan meghatározott szabályok szerint kerülnek átalakításra Java alaptípussá.

<!ELEMENT adapt (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST adapt

type CDATA #REQUIRED

Ezzel az elemmel adaptálható a fókuszban lévő objektum a type attribútummal megadott típusra. A kifejezés EvaluationResult.NOT_LOADED értéket ad vissza, ha a hivatkozott adapter vagy típus még nincs betöltve. ExpressionException kivételt ad a kiértékelés során, ha a típus neve egyáltalán nem létezik. Az adapt kifejezések leszármazottai az "and" operátorral kombinálhatók.

• type - a típus, amelyre a fókuszban lévő objektumot adaptálni kell

<!ELEMENT iterate (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST iterate

operator (or|and)

ifEmpty  (true | false)

Ezzel az elemmel lehet végiglépkedni egy java.util.Collection típusú változón, vagy egy org.eclipse.core.expressions.IIterable felületet adaptáló változón. Ha a fókuszban lévő objektum nem a fentiek egyike, akkor a kifejezés kiértékelésekor egy ExpressionStatus értéket tartalmazó CoreException kivétel történik. Egy iterate kifejezés leszármazott kifejezései az "and" operátor segítségével kombinálhatók.

• operator - "and" vagy "or". Az operátor határozza meg, hogy a Collection agy IIterable egyes utódaira alkalmazott összes leszármazott kifejezés eredménye hogyan legyen kombinálva, és milyen rövidzárlat kiértékelés (ha van ilyen) kerül felhasználásra. Ha nincs megadva, akkor az "and" lesz használva.
• ifEmpty - az "iterate" kifejezés által visszaadott érték, ha a collection üres. Ha nincs megadva, akkor EvaluationResult.TRUE kerül visszaadásra, ha az operátor "and", és EvaluationResult.FALSE, ha az operátor "or".

<!ELEMENT reference EMPTY>

<!ATTLIST reference

definitionId IDREF #REQUIRED

Az elem az org.eclipse.core.expressions.definitions kiterjesztési pontból származó kifejezésre hivatkozik. A kifejezés definíciója az aktuális kifejezéselemen belül kerül majd kiértékelésre az aktuális kiértékelési kontextus használatával.

• definitionId - Az org.eclipse.core.expressions.definitions kiterjesztési pontból származó kifejezés egyedi azonosítója.

Példák:

 <extension point="org.eclipse.wst.jsdt.ui.quickFixProcessors">
  <quickFixProcessor
   id="AdvancedQuickFixProcessor"
   name="Fejlett gyorsjavítás feldolgozó"
   requiredSourceLevel="1.5"
   class="com.example.AdvancedQuickFixProcessor">
   <handledMarkerTypes>
      <markerType id="org.eclipse.myplugin.audits"/>
   </handledMarkerTypes>
   <enablement>
      <with variable="projectNatures">
         <iterate operator="or">
            <equals value="org.eclipse.wst.jsdt.core.javanature"/>
         </iterate>
      </with>
   </enablement>
  </quickFixProcessor>
 </extension>

API információk:

Copyright (c) 2007 IBM Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz tartozó, illetve a http://www.eclipse.org/legal/epl-v10.html címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek közzétéve.