Filtre.Filter

java.lang.Object
- Filtre.Filter

Nadradená trieda:

Filtre
```
public static class Filtre.Filter
extends Object
```
Táto vnorená trieda je trieda prvkov zoznamu triedy Filtre a zároveň môže slúžiť na sprostredkovanie jednoduchších úkonov s regulárnymi výrazmi.

Príklad využitia tejto triedy ukazuje miniprojekt dostupný tu: FilterFiles. (Tento miniprojekt bol pôvodne inšpiráciou na vznik tejto triedy rámca, ktorá bola potom spätne do tohto miniprojektu zapracovaná.)

Pozri tiež:

Filtre

Prehľad atribútov

Atribúty
Modifikátor a typ	Atribút a opis
`String`	`nahradenie` Tento atribút obsahuje šablónu nahrádzania vloženú do parametra konštruktora `nahradenie`.
`Pattern`	`vzor` Do tohto atribútu sa ukladá inštancia vzoru vytvoreného podľa parametra `vzor` vloženého do konštruktora.
`boolean`	`zastav` Tento atribút je používaný v rámci nadradenej triedy `Filtre`.
`Matcher`	`zhoda` Tento atribút je naplnený po volaní metód `zhoda`, `nahradenie` a `Filtre.použi(reťazec)`.

Prehľad konštruktorov

Konštruktory
Konštruktor a opis

Filter(String vzor, String nahradenie)
Konštruktor filtra.

Konštruktory
Konštruktor a opis
`Filter(String vzor, String nahradenie)` Konštruktor filtra.

Prehľad metód

Všetky metódy Inštančné metódy Skutočne definované metódy
Modifikátor a typ	Metóda a opis
`String`	`nahradenie(String reťazec)` Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra šablónou zadanou do konštruktora.
`String`	`nahradenie(String reťazec, Function<Matcher,String> funkcia)` Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra prostredníctvom funkcie zadanej do druhého parametra.
`String`	`nahradenie(String reťazec, String záložnýReťazec)` Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra šablónou zadanou do konštruktora.
`String`	`nahradenieCelku(String reťazec)` Funguje rovnako ako metóda `nahradenieCelku(reťazec, záložnýReťazec)`, ale namiesto záložného reťazca dosadí pôvodný reťazec.
`String`	`nahradenieCelku(String reťazec, String záložnýReťazec)` Nahradí celý zadaný reťazec šablónou toho filtra (zadanou do konštruktora) ak ako celok vyhovuje vzoru (regulárnemu výrazu) tohto filtra.
`Matcher`	`zhoda(String reťazec)` Porovná zadaný reťazec so vzorom zadávaným do konštruktora a vráti zodpovedajúci objekt `Matcher`.

Metódy zdedené z triedy java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Podrobnosti atribútov
  - vzor
```
public Pattern vzor
```
    Do tohto atribútu sa ukladá inštancia vzoru vytvoreného podľa parametra vzor vloženého do konštruktora. (Atribút je dostupný na čítanie aj zápis. Ak sa jeho obsah zmení, filter bude pracovať so zmeneným obsahom.)
  - nahradenie
```
public String nahradenie
```
    Tento atribút obsahuje šablónu nahrádzania vloženú do parametra konštruktora nahradenie.
  - zastav
```
public boolean zastav
```
    Tento atribút je používaný v rámci nadradenej triedy Filtre. Metóda Filtre.použi(reťazec) ho používa na overenie toho, či sa má proces fitrovania zastaviť po úspešnej aplikácii tohto filtra. (Pozri aj opis metódy Filtre.čítaj(reťazec).)
  - zhoda
```
public Matcher zhoda
```
    Tento atribút je naplnený po volaní metód zhoda, nahradenie a Filtre.použi(reťazec). Ak ho nenaplníme sami iným spôsobom, tak bude jeho hodnota rovná null.
- Podrobnosti konštruktorov
  - Filter
```
public Filter(String vzor,
              String nahradenie)
```
    Konštruktor filtra. Parameter vzor musí obsahovať platný regulárny výraz, inak vznikne výnimka. Pozri aj metódu: Pattern.{Pattern#compile(String) compile}(regex).
    
    Parametre:
    
    vzor – regulárny výraz na porovnávanie reťazcov (na ktoré bude aplikovaný tento filter)
    
    nahradenie – šablóna reťazca na nahrádzanie zhôd podľa regulárneho výrazu v parametri vzor
- Podrobnosti metód
  - zhoda
```
public Matcher zhoda(String reťazec)
```
    Porovná zadaný reťazec so vzorom zadávaným do konštruktora a vráti zodpovedajúci objekt Matcher.
    
    Parametre:
    
    reťazec – reťazec na porovnanie podľa vzoru (regulárneho výrazu) tohto filtra
    
    Návratová hodnota:
    
    objekt Matcher, ktorý dovoľuje overiť, či zadaný reťazec alebo jeho časť vyhovuje vzoru tohto filtra
  - nahradenie
```
public String nahradenie(String reťazec,
                         String záložnýReťazec)
```
    Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra šablónou zadanou do konštruktora. Pozri Filter(vzor, nahradenie). Výsledok nahrádzania vráti v návratovej hodnote. Ak nebolo vykonané žiadne nahradenie, tak metóda vráti obsah záložného reťazca.
    
    Parametre:
    
    reťazec – reťazec, v ktorom sa budú hľadať zhody podľa vzoru (regulárneho výrazu), ktoré budú nahradené podľa šablóny nahrádzania zadanej do konštruktora tohto filtra
    
    záložnýReťazec – záložný reťazec, ktorý bude vrátený v prípade, že nebolo vykonané žiadne nahradenie; (tip: ak je argument priamo parametrom, dá sa použiť operátor zhody (==) na overenie toho, či bolo niečo nahradené)
    
    Návratová hodnota:
    
    výsledok spracovania (podľa pravidiel opísaných vyššie)
  - nahradenie
```
public String nahradenie(String reťazec)
```
    Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra šablónou zadanou do konštruktora. Pozri Filter(vzor, nahradenie). Výsledok nahrádzania vráti v návratovej hodnote. Ak nebolo vykonané žiadne nahradenie, tak metóda vráti pôvodný tvar reťazca.
    
    Parametre:
    
    reťazec – reťazec, v ktorom sa budú hľadať zhody podľa vzoru (regulárneho výrazu), ktoré budú nahradené podľa šablóny nahrádzania zadanej do konštruktora tohto filtra; (tip: ak je argument priamo parametrom, dá sa použiť operátor zhody (==) na overenie toho, či bolo niečo nahradené)
    
    Návratová hodnota:
    
    výsledok spracovania (podľa pravidiel opísaných vyššie)
  - nahradenie
```
public String nahradenie(String reťazec,
                         Function<Matcher,String> funkcia)
```
    Nahradí všetky časti zadaného reťazca, ktoré vyhovujú vzoru (regulárnemu výrazu) tohto filtra prostredníctvom funkcie zadanej do druhého parametra. Funkcia bude spustená pri každom nahrádzaní. Jej parametrom je aktuálna inštancia zhody (Matcher) a návratovou hodnotou reťazec, ktorým bude nahradená časť vyhovujúca vzoru. Po dokončení spracovania je výsledok vrátený v návratovej hodnote tejto metódy. Ak nebolo vykonané žiadne nahradenie, tak metóda vráti pôvodný tvar reťazca.
    
    Zdroje:
    - Matcher (Java Platform SE 8) – appendReplacement(StringBuffer sb, String replacement). 1993, 2023, Oracle and/or its affiliates. Citované: 30. júla 2023.
    - Russler, Nick: String replace with callback in Java (like in JavaScript). WhiteByte. 8. december 2014 Citované: 30. júla 2023. (Nájdené vďaka: What is the equivalent of Regex-replace-with-function-evaluation in Java 7? – Stack Overflow.)
    Parametre:
    
    reťazec – predloha – reťazec určený na spracovanie; (tip: ak je argument priamo parametrom, dá sa použiť operátor zhody (==) na overenie toho, či bolo niečo nahradené)
    
    funkcia – funkcia, ktorá bude spustená pri každom nahrádzaní
    
    Návratová hodnota:
    
    výsledok spracovania (podľa pravidiel opísaných vyššie)
  - nahradenieCelku
```
public String nahradenieCelku(String reťazec,
                              String záložnýReťazec)
```
    Nahradí celý zadaný reťazec šablónou toho filtra (zadanou do konštruktora) ak ako celok vyhovuje vzoru (regulárnemu výrazu) tohto filtra. (Pozri aj vzor a nahradenie v konštruktore: Filter(vzor, nahradenie).) Ak reťazec vyhovie filtru, tak metóda vráti v návratovej hodnote výsledok nahrádzania. V opačnom prídade vráti zadaný záložný reťazec.
    
    Parametre:
    
    reťazec – reťazec, ktorý bude porovnaný s regulárnym výrazom vzoru filtra ako celok a v prípade zhody nahradený podľa šablóny nahrádzania (zadanej do konštruktora tohto filtra)
    
    záložnýReťazec – záložný reťazec, ktorý bude vrátený v prípade, že tento reťazec ako celok nevyhovie vzoru filtra; (tip: ak je argument priamo parametrom, dá sa použiť operátor zhody (==) na overenie toho, či bolo niečo nahradené)
    
    Návratová hodnota:
    
    výsledok spracovania (podľa pravidiel opísaných vyššie)
  - nahradenieCelku
```
public String nahradenieCelku(String reťazec)
```
    Funguje rovnako ako metóda nahradenieCelku(reťazec, záložnýReťazec), ale namiesto záložného reťazca dosadí pôvodný reťazec.
    
    Parametre:
    
    reťazec – reťazec, ktorý bude porovnaný s regulárnym výrazom vzoru filtra ako celok a v prípade zhody nahradený podľa šablóny nahrádzania (zadanej do konštruktora tohto filtra); (tip: ak je argument priamo parametrom, dá sa použiť operátor zhody (==) na overenie toho, či bolo niečo nahradené)
    
    Návratová hodnota:
    
    výsledok spracovania

Trieda Filtre.Filter

Prehľad atribútov

Prehľad konštruktorov

Prehľad metód

Metódy zdedené z triedy java.lang.Object

Podrobnosti atribútov

vzor

nahradenie

zastav

zhoda

Podrobnosti konštruktorov

Filter

Podrobnosti metód

zhoda

nahradenie

nahradenie

nahradenie

nahradenieCelku

nahradenieCelku