Ohjelmointirajapinnan rajoitusten määrittäminen

Ohjelmointirajapinnan työkalut sisältävät Javadoc-tunnisteita, joilla ohjelmointirajapinnan käyttöä voidaan erikseen dokumentoida ja rajoittaa. Seuraavissa taulukoissa on tiivistelmä kunkin jäsenen tukemista Javadoc-tunnisteista ja kunkin tunnisteen semantiikasta.

Asiakas viittaa lisäosaan tai resurssijoukkoon, joka vaatii resurssijoukkoa, jossa kyseessä oleva ohjelmointirajapinta on määritetty. Rajoituksia ei toteuteta samassa resurssijoukossa, jossa ohjelmointirajapinta on määritetty. Esimerkiksi resurssijoukko, jossa tietty rajapinta on merkitty @noimplement-tunnisteella, voi sisältää kyseisen rajapinnan toteutuksen.

Tuetut rajoitustunnisteet

  Luokka Rajapinta metodi konstruktori

Lopullinen kenttä

Ei-lopullinen kenttä
@noimplement
-
Tuettu
-
-
-
-
@noextend
Tuettu
Tuettu
-
-
-
-
@noinstantiate
Tuettu
-
-
-
-
-
@nooverride
-
-
Tuettu
-
-
-
@noreference
-
-
Tuettu
Tuettu
-
Tuettu

Rajoitusten semantiikka

@noimplement

Ilmaisee, että asiakkaiden ei tule toteuttaa tätä rajapintaa. Luokat, joissa käytetään implements-avainsanaa kyseessä olevan rajapinnan tai sen pääobjektin yhteydessä, kun toteuttavaa yliluokkaa ei ole, merkitään ongelmiksi.

@noextend
Ilmaisee, että asiakkaiden ei tule laajentaa tätä luokkaa tai rajapintaa. Luokat tai rajapinnat, joissa käytetään extends-avainsanaa kyseessä olevan lajin yhteydessä, merkitään ongelmiksi.
@noinstantiate
Ilmaisee, että asiakkaiden ei tule luoda tämän luokan ilmentymää. Koodi, jossa kyseessä olevan luokan ilmentymä luodaan konstruktorilla, merkitään ongelmaksi.
@nooverride
Ilmaisee, että asiakkaiden ei tule esitellä tätä metodia uudelleen. Kaikki aliluokat, joissa määritetään kyseessä olevan metodin ohittava metodi, merkitään ongelmiksi.
@noreference
Ilmaisee, että asiakkaiden ei tule viitata tähän metodiin, konstruktoriin tai ei-lopulliseen kenttään. Koodi, joka kutsuu suoraan kyseessä olevaa metodia tai konstruktoria tai viittaa kyseessä olevaan ei-lopulliseen kenttään, merkitään ongelmaksi.

Aiheeseen liittyviä tehtäviä

Perustason määritys

Aiheeseen liittyviä ohjeita

Javadoc-tunnisteen @since hallinta
Ohjelmointirajapintojen perustasojen oletusasetukset
Ohjelmointirajapintojen virheiden ja varoitusten oletusasetukset