Propriedade (programação) - Property (programming)

Uma propriedade , em algumas linguagens de programação orientadas a objetos , é um tipo especial de membro de classe , intermediário em funcionalidade entre um campo (ou membro de dados) e um método . A sintaxe para leitura e gravação de propriedades é como para campos, mas as leituras e gravações de propriedades são (geralmente) traduzidas para chamadas de método ' getter ' e ' setter '. A sintaxe semelhante a um campo é mais fácil de ler e escrever do que muitas chamadas de método, mas a interposição de chamadas de método "nos bastidores" permite a validação de dados , atualização ativa (por exemplo, de elementos GUI ) ou implementação do que pode ser chamado de " campos somente leitura ".

Veja um exemplo instrutivo para a linguagem C # abaixo.

Suporte em idiomas

As linguagens de programação que oferecem suporte a propriedades incluem ActionScript 3 , C # , D , Delphi / Free Pascal , eC , F # , Kotlin , JavaScript , Objective-C 2.0 , Python , Scala , Swift , Lua e Visual Basic .

Algumas linguagens orientadas a objetos, como Java e C ++ , não oferecem suporte a propriedades e exigem que o programador defina um par de métodos acessadores e modificadores .

Oberon-2 fornece um mecanismo alternativo usando sinalizadores de visibilidade de variável de objeto.

Outras linguagens projetadas para a Java Virtual Machine , como Groovy , oferecem suporte nativo a propriedades.

Embora C ++ não tenha propriedades de primeira classe, elas podem ser emuladas devido à sobrecarga do operador .

Observe também que alguns compiladores C ++ oferecem suporte a propriedades de primeira classe (o compilador Microsoft C ++ como exemplo).

Na maioria das linguagens, as propriedades são implementadas como um par de métodos acessadores / modificadores, mas acessadas usando a mesma sintaxe dos campos públicos. A omissão de um método do par produz uma propriedade somente leitura ou uma propriedade somente gravação incomum .

Em algumas linguagens sem suporte integrado para propriedades, uma construção semelhante pode ser implementada como um único método que retorna ou altera os dados subjacentes, dependendo do contexto de sua invocação. Essas técnicas são usadas, por exemplo, em Perl .

Algumas linguagens (Ruby, Smalltalk) alcançam sintaxe semelhante a propriedades usando métodos normais, às vezes com uma quantidade limitada de açúcar sintático .

Variantes de sintaxe

Algumas linguagens seguem convenções de sintaxe bem estabelecidas para especificar e utilizar propriedades e métodos formalmente.

Entre essas convenções:

  • Notação de ponto
  • Notação de colchetes

Notação de ponto

O exemplo a seguir demonstra a notação de ponto em JavaScript.

document.createElement('pre');

Notação de colchetes

O exemplo a seguir demonstra a notação de colchetes em JavaScript.

document['createElement']('pre');

Sintaxe de exemplo

C #

class Pen 
{
    private int color; // private field
    
    // public property
    public int Color 
    {  
        get
        {
            return this.color;
        }
        set 
        {
            if (value > 0) {
                this.color = value;
            }
        }
    }
}
// accessing:
Pen pen = new Pen();
int color_tmp = 0;
// ...
pen.Color = 17;
color_tmp = pen.Color;
// ...
pen.Color = ~pen.Color; // bitwise complement ...

// another silly example:
pen.Color += 1; // a lot clearer than "pen.set_Color(pen.get_Color() + 1)"!

As versões C # recentes também permitem "propriedades implementadas automaticamente", em que o campo de apoio da propriedade é gerado pelo compilador durante a compilação. Isso significa que a propriedade deve ter um configurador. No entanto, pode ser privado.

class Shape 
{
    
    public Int32 Height { get; set; }
    public Int32 Width  { get; private set; }
    
}

C ++

C ++ não tem propriedades de primeira classe, mas existem várias maneiras de emular propriedades em um grau limitado. Dois dos quais se seguem:

#include <iostream>

template <typename T> class property {
        T value;
    public:
        T & operator = (const T &i) {
            return value = i;
        }
        // This template class member function template serves the purpose to make
        // typing more strict. Assignment to this is only possible with exact identical types.
        // The reason why it will cause an error is temporary variable created while implicit type conversion in reference initialization.
        template <typename T2> T2 & operator = (const T2 &i) {
            T2 &guard = value;
            throw guard; // Never reached.
        }

        // Implicit conversion back to T. 
        operator T const & () const {
            return value;
        }
};

struct Foo {
    // Properties using unnamed classes.
    class {
            int value;
        public:
            int & operator = (const int &i) { return value = i; }
            operator int () const { return value; }
    } alpha;

    class {
            float value;
        public:
            float & operator = (const float &f) { return value = f; }
            operator float () const { return value; }
    } bravo;
};

struct Bar {
    // Using the property<>-template.
    property <bool> alpha;
    property <unsigned int> bravo;
};

int main () {
    Foo foo;
    foo.alpha = 5;
    foo.bravo = 5.132f;

    Bar bar;
    bar.alpha = true;
    bar.bravo = true; // This line will yield a compile time error
                      // due to the guard template member function.
    ::std::cout << foo.alpha << ", "
                << foo.bravo << ", "
                << bar.alpha << ", "
                << bar.bravo
                << ::std::endl;
    return 0;
}

C ++, Microsoft e C ++ Builder específico

Um exemplo retirado da página de documentação do MSDN .

// declspec_property.cpp
struct S
{
   int i;
   void putprop(int j)
   { 
      i = j;
   }

   int getprop()
   {
      return i;
   }

   __declspec(property(get = getprop, put = putprop)) int the_prop;
};

int main()
{
   S s;
   s.the_prop = 5;
   return s.the_prop;
}

D

class Pen
{
    private int m_color; // private field
    
    // public get property
    public int color () {
        return m_color;
    }
    
    // public set property
    public void color (int value) {
         m_color = value;
    }
}
auto pen = new Pen;
pen.color = ~pen.color; // bitwise complement

// the set property can also be used in expressions, just like regular assignment
int theColor = (pen.color = 0xFF0000);

Na versão D 2, cada acessador de propriedade ou modificador deve ser marcado com @property:

class Pen
{
    private int m_color; // private field
    
    // public get property
    @property public int color () {
        return m_color;
    }
    
    // public set property
    @property public void color (int value) {
        m_color = value;
    }
}

Delphi / Free Pascal

type TPen = class
  private
    FColor: TColor;
    function GetColor: TColor;
    procedure SetColor(const AValue: TColor);
  public
    property Color: Integer read GetColor write SetColor;
end;

function TPen.GetColor: TColor;
begin
  Result := FColor;
end;

procedure TPen.SetColor(const AValue: TColor);
begin
  if FColor <> AValue
   then FColor := AValue;
end;
// accessing:
var Pen: TPen;
// ...
Pen.Color := not Pen.Color;

(*
Delphi also supports a 'direct field' syntax -

property Color: TColor read FColor write SetColor;

or

property Color: TColor read GetColor write FColor;

where the compiler generates the exact same code as for reading and writing
a field. This offers the efficiency of a field, with the safety of a property.
(You can't get a pointer to the property, and you can always replace the member
access with a method call.)
*)

eC

class Pen 
{
   // private data member
   Color color;
public:
   // public property
   property Color color 
   {  
      get { return color; }
      set { color = value; }
   }
}
Pen blackPen { color = black };
Pen whitePen { color = white };
Pen pen3 { color = { 30, 80, 120 } };
Pen pen4 { color = ColorHSV { 90, 20, 40 } };

F #

type Pen() = class
    let mutable _color = 0

    member this.Color
        with get() = _color
        and set value = _color <- value
end
let pen = new Pen()
pen.Color <- ~~~pen.Color

JavaScript

function Pen() {
    this._color = 0;
}
// Add the property to the Pen type itself, can also
// be set on the instance individually
Object.defineProperties(Pen.prototype, {
    color: {
        get: function () {
            return this._color;
        },
        set: function (value) {
            this._color = value;
        }
    }
});
var pen = new Pen();
pen.color = ~pen.color; // bitwise complement
pen.color += 1; // Add one

ActionScript 3.0

package  {
	public class Pen {
		private var _color:uint = 0;
		
		public function get color():uint {
			return _color;
		}
		
		public function set color(value:uint):void {
			_color = value;
		}
	}
}
var pen:Pen = new Pen();
pen.color = ~pen.color; // bitwise complement
pen.color += 1; // add one

Objective-C 2.0

@interface Pen : NSObject
@property (copy) NSColor *colour;	// The "copy" attribute causes the object's copy to be
					// retained, instead of the original.
@end

@implementation Pen
@synthesize colour;			// Compiler directive to synthesise accessor methods.
					// It can be left behind in Xcode 4.5 and later.
@end

O exemplo acima pode ser usado em um método arbitrário como este:

Pen *pen = [[Pen alloc] init];
pen.colour = [NSColor blackColor];
float red = pen.colour.redComponent;
[pen.colour drawSwatchInRect: NSMakeRect(0, 0, 100, 100)];

PHP

class Pen
{
    private int $color = 1;

    function __set($property, $value)
    {
        if (property_exists($this, $property)) { 
            $this->$property = $value;
        }
    }

    function __get($property)
    {
        if (property_exists($this, $property)) {
            return $this->$property;
        }
        return null;
    }
}
$p = new Pen();
$p->color = ~$p->color; // Bitwise complement
echo $p->color;

Pitão

As propriedades funcionam corretamente apenas para classes de novo estilo (classes que têm objectuma superclasse ) e estão disponíveis apenas no Python 2.2 e mais recente (consulte a seção relevante do tutorial Unificando tipos e classes no Python 2.2 ). Python 2.6 adicionou uma nova sintaxe envolvendo decoradores para definir propriedades.

class Pen:
    def __init__(self) -> None:
        self._color = 0  # "private" variable

    @property
    def color(self):
        return self._color

    @color.setter
    def color(self, color):
        self._color = color
pen = Pen()
# Accessing:
pen.color = ~pen.color  # Bitwise complement ...

Rubi

class Pen
  def initialize
    @color = 0
  end
    
  # Defines a getter for the @color field
  def color
    @color
  end

  # Defines a setter for the @color field
  def color=(value)
    @color = value
  end
end

pen = Pen.new
pen.color = ~pen.color    # Bitwise complement

Ruby também fornece sintetizadores getter / setter automáticos definidos como métodos de instância de Class.

class Pen
  attr_reader :brand    # Generates a getter for @brand (Read-Only)
  attr_writer :size     # Generates a setter for @size  (Write-Only)
  attr_accessor :color  # Generates both a getter and setter for @color (Read/Write)

  def initialize
    @color = 0          # Within the object, we can access the instance variable directly
    @brand = "Penbrand"
    @size = 0.7         # But we could also use the setter method defined by the attr_accessor Class instance method
  end
end

pen = Pen.new
puts pen.brand           # Accesses the pen brand through the generated getter
pen.size = 0.5           # Updates the size field of the pen through the generated setter
pen.color = ~pen.color

Visual básico

Visual Basic (.NET 2003-2010)

Public Class Pen
 
    Private _color As Integer ' Private field

    Public Property Color() As Integer ' Public property
        Get
            Return _color
        End Get
        Set(ByVal value As Integer)
            _color = value
        End Set
    End Property

End Class
' Create Pen class instance
Dim pen As New Pen()

' Set value
pen.Color = 1

' Get value
Dim color As Int32 = pen.Color

Visual Basic (apenas .NET 2010)

Public Class Pen

    Public Property Color() As Integer ' Public property

End Class
' Create Pen class instance
Dim pen As New Pen()

' Set value
pen.Color = 1

' Get value
Dim color As Int32 = pen.Color

Visual Basic 6

' in a class named clsPen
Private m_Color As Long

Public Property Get Color() As Long
    Color = m_Color
End Property

Public Property Let Color(ByVal RHS As Long)
    m_Color = RHS
End Property
' accessing:
Dim pen As New clsPen
' ...
pen.Color = Not pen.Color

Veja também