Marker interface pattern: Difference between revisions

Revision as of 11:42, 14 October 2010

Latest revision as of 13:29, 20 July 2025

(44 intermediate revisions by 32 users not shown)

Line 1:

{{Short description|Design pattern in computer science}}

{{UnreferencedRefimprove|date=June 20072013}}

The '''marker interface pattern''' is a [[design pattern (computer science)|design pattern]] in [[computer science]], used with languages that provide run-time type information about objects. It provides a means to associate metadata with a class where the language does not have explicit support for such metadata.

To use this pattern, a [[Class (computer science)|class]] implements a '''marker interface'''<ref name="EffectiveJava">

To use this pattern, a [[Class (computer science)|class]] implements a '''marker interface''', and methods that interact with instances of that class test for the existence of the interface. Whereas a typical [[interface (computer science)|interface]] specifies functionality (in the form of method declarations) that an implementing class must support, a marker interface need not do so. The mere presence of such an interface indicates specific behavior on the part of the implementing class. Hybrid interfaces, which both act as markers and specify required methods, are possible but may prove confusing if improperly used.

{{cite book

| last = Bloch

| first = Joshua

| title = Effective Java

| page = [https://archive.org/details/effectivejava00bloc_0/page/179 179]

| chapter = Item 37: Use marker interfaces to define types

| year = 2008

| isbn = 978-0-321-35668-0

| publisher = Addison-Wesley

| chapter-url-access = registration

| chapter-url = https://archive.org/details/effectivejava00bloc_0/page/179

| edition = Second

To use this pattern, a [[Class }}</ref> (computeralso science)|class]] implements acalled '''markertagging interface''') which is an empty interface,<ref>{{Cite web |date=2017-03-06 |title=Marker interface in Java |url=https://www.geeksforgeeks.org/marker-interface-java/ |access-date=2022-05-01 |website=GeeksforGeeks |language=en-us}}</ref> and methods that interact with instances of that class test for the existence of the interface. Whereas a typical [[interface (computer science)|interface]] specifies functionality (in the form of method declarations) that an implementing class must support, a marker interface need not do so. The mere presence of such an interface indicates specific behavior on the part of the implementing class. Hybrid interfaces, which both act as markers and specify required methods, are possible but may prove confusing if improperly used.

== CritiqueExample ==

An example of the application of marker interfaces from the [[Java (programming language)|Java programming language]] is the {{Javadoc:SE|java/io|Serializable}} interface. A class implements this interface to indicate that its non-[[Transient (computer programming)|transient]] data members can be written to an {{Javadoc:SE|java/io|ObjectOutputStream}}. The <code>ObjectOutputStream</code> private method <code>writeObject()</code> contains a series of <code>instanceof</code> tests to determine writeability, one of which looks for the <code>Serializable</code> interface. If none of these tests pass, the method throws a <code>NotSerializableException</code>.

An example of the application of marker interfaces from the [[Java (programming language)|Java programming language]] is the {{Javadoc:SE|java/io|Serializable}} interface:<syntaxhighlight lang="java">

package java.io;

public interface Serializable {

== Critique ==

}

An example of the application of marker interfaces from the [[Java (programming language)|Java programming language]] is the {{Javadoc:SE|java</io|Serializable}} interface. syntaxhighlight>A class implements this interface to indicate that its non-[[Transient (computer programming)|transient]] data members can be written to an {{Javadoc:SE|java/io|ObjectOutputStream}}. The <code>ObjectOutputStream</code> private method <code>writeObjectwriteObject0(Object,boolean)</code> contains a series of <code>instanceof</code> tests to determine writeability, one of which looks for the <code>Serializable</code> interface. If noneany of these tests passfails, the method throws a <code>NotSerializableException</code>.

A major problem with marker interfaces is that an interface defines a contract for implementing classes, and that contract is inhe

== See also Critique==

One problem with marker interfaces is that, since an interface defines a contract for implementing classes, and that contract is inherited by all subclasses, a marker cannot be "unimplemented". In the example given, any subclass not intended for serialization (perhaps it depends on transient state), must explicitly throw NotSerializableException exceptions (per <code>ObjectOutputStream</code> docs).

* [[Design marker]]s for an expansion of this pattern.

Another solution is for the language to support [[metadata]] directly:

[[Category:Software design patterns]]

* Both the [[.NET Framework]] and [[Java (software platform)|Java]] (as of Java 5 (1.5)) provide support for such metadata. In .NET, they are called ''"custom attributes"'', in Java they are called ''"[[Java annotation|annotations]]"''. Despite the different name, they are conceptually the same thing. They can be defined on classes, member variables, methods, and method parameters and may be accessed using [[Reflection (computer science)|reflection]].

[[Category:Java programming language]]

* In [[Python (programming language)|Python]], the term "marker interface" is common in [[Zope]] and [[Plone (software)|Plone]]. Interfaces are declared as metadata and subclasses can use <code>implementsOnly</code> to declare they do not implement everything from their super classes.

==See also==

[[de:Markierungsschnittstelle]]

* [[Design marker]]s for an expansion of this pattern.

[[ja:マーカーインタフェース]]

==References==

{{Reflist}}

== Further reading ==

''Effective Java''<ref>{{Cite book |last=Bloch |first=Joshua |title=Effective Java |date=2018 |isbn=978-0-13-468599-1 |edition=Third |___location=Boston |oclc=1018432176}}</ref> by [[Joshua Bloch]].

{{Design Patterns patterns}}

[[Category:Software design patterns]]

[[Category:Java (programming language)]]