# -*- perl -*-
# DO NOT EDIT - This file is generated by UML2CODE.
# From template: $Id: PerlTemplate.txt,v 1.12 2003/05/11 06:16:02 stephens Exp $

package UML::MetaModel::Foundation::Core::Comment;

use 5.6.1;
use strict;
use warnings;

#################################################################
# Version
#

our $VERSION = do { my @r = (q$Revision: 1.12 $ =~ /\d+/g); sprintf "%d." . "%03d" x $#r, @r };

#################################################################
# Dependencies
#



use Carp qw(croak confess);

#################################################################
# Generalizations
#

use base qw(
  UML::MetaModel::Foundation::Core::ModelElement


);

#################################################################
# Exports
#

our @EXPORT_OK = qw(
);
our %EXPORT_TAGS = ( ':all' => \@EXPORT_OK );





#################################################################
# Validation
#


=head2 __validate_type

  UML::MetaModel::Foundation::Core::Comment->__validate_type($value);

Returns true if $value is a valid value of UML::MetaModel::Foundation::Core::Comment.

=cut
sub __validate_type($$)
{
  my ($self, $x) = @_;

  no warnings;

  UNIVERSAL::isa($x, 'UML::MetaModel::Foundation::Core::Comment')  ;
}


=head2 __typecheck

  UML::MetaModel::Foundation::Core::Comment->__typecheck($value, $msg);

Calls C<confess()> with C<$msg> if C<UML::MetaModel::Foundation::Core::Comment-E<GT>__validate_type($value)> is false.

=cut
sub __typecheck
{
  my ($self, $x, $msg) = @_;

  confess("typecheck: $msg: type 'UML::MetaModel::Foundation::Core::Comment': value '$x'")
    unless __validate_type($self, $x);
}


=head2 isaComment

Returns true if receiver is a C<UML::MetaModel::Foundation::Core::Comment>.
Other receivers will return false.

=cut
sub isaComment { 1 }


=head2 isaFoundation__Core__Comment

Returns true if receiver is a C<UML::MetaModel::Foundation::Core::Comment>.
Other receivers will return false.
This is the fully qualified version of the C<isaComment> method.

=cut
sub isaFoundation__Core__Comment { 1 }


#################################################################
# Introspection
#

=head2 __model_name 

  my $name = $obj_or_package->__model_name;

Returns the UML Model name (C<'Foundation::Core::Comment'>) for an object or package of
this Classifier.

=cut
sub __model_name { 'Foundation::Core::Comment' }




  



# ASSOC: 

  


#################################################################
# Class Attributes
#


      

#################################################################
# Initialization
#

 
=head2 __intialize

Initialize all slots in this Classifier.
Does not initlaize slots in Generalizations.

See also: C<_initialize>.

=cut
sub __initialize
{
  my ($self) = @_;

  # Attributes

    # Attribute name
  if ( exists $self->{'name'} ) {
    my $x = $self->{'name'};
    $self->{'name'} = undef;
    $self->set_name($x);
  } else {
      }
  


  # Associations

  # AssociationEnd 
  #   0..*
  #  <--> 
  #  annotatedElement 0..* UML::MetaModel::Foundation::Core::ModelElement.
    if ( defined $self->{'annotatedElement'} && @{$self->{'annotatedElement'}} ) {
    my $x = $self->{'annotatedElement'};
    $self->{'annotatedElement'} = [ ];
    $self->set_annotatedElement(@$x);
  }
  

  $self;
}


my $__initialize_use;

=head2 _intialize

Initialize all slots in this Classifier and all Generalizations.

See also: C<__initialize>.

=cut
sub _initialize
{
  my ($self) = @_;

  # $DB::single = 1;

  unless ( ! $__initialize_use ) {
    $__initialize_use = 1;
    $self->__use('UML::MetaModel::Foundation::Core::Element');
    $self->__use('UML::MetaModel::Foundation::Core::ModelElement');
  }

  $self->UML::MetaModel::Foundation::Core::Comment::__initialize;
  $self->UML::MetaModel::Foundation::Core::Element::__initialize;
  $self->UML::MetaModel::Foundation::Core::ModelElement::__initialize;

  $self;
}
      

#################################################################
# Attributes
#



#################################################################
# Attribute name
# type = UML::MetaModel::Foundation::Data_Types::String
# multiplicity = 1

=head2 name

  my $val = $obj->name;

Returns the value of Attribute name.

=cut
sub name ($)
{
  my ($self) = @_;

  $self->{'name'};
}


=head2 set_name

  $obj->set_name($val);

Sets the value of Attribute name.
C<$val> must be of type C<UML::MetaModel::Foundation::Data_Types::String>.
Returns C<$obj>.

=cut
sub set_name ($$)
{
  my ($self, $val) = @_;

  $self->__use('UML::MetaModel::Foundation::Data_Types::String')->__typecheck($val, "UML::MetaModel::Foundation::Core::Comment.name");

  $self->{'name'} = $val;

  $self
}


#################################################################
# Association
#


#################################################################
# AssociationEnd  => annotatedElement
# type = UML::MetaModel::Foundation::Core::ModelElement
# multiplicity = 0..*

=head2 annotatedElement

  my @val = $obj->annotatedElement;
  my $ary_val = $obj->annotatedElement;

Returns the AssociationEnd value.
In array context, returns all the objects in the Association.
In scalar context, returns an array ref of all the objects in the Association.

=cut
sub annotatedElement ($)
{
  my ($self) = @_;
		  
  my $x = $self->{'annotatedElement'} ||= [ ];
  wantarray ? @{$x} : $x;
}


=head2 set_annotatedElement

  $obj->set_annotatedElement(@val);

Sets the AssociationEnd value.
Elements of C<@val> must of of type C<UML::MetaModel::Foundation::Core::ModelElement>.
Returns C<$obj>.

=cut
sub set_annotatedElement ($@)
{
  my ($self, @val) = @_;
  
  $self->clear_annotatedElement;
  $self->add_annotatedElement(@val);
}


=head2 add_annotatedElement

  $obj->add_annotatedElement(@val);

Sets the AssociationEnd value.
Elements of C<@val> must of of type C<UML::MetaModel::Foundation::Core::ModelElement>.
Returns C<$obj>.

=cut
sub add_annotatedElement ($@)
{
  my ($self, @val) = @_;
  
  my $x = $self->{'annotatedElement'} ||= [ ];
  my $old; # Place holder for other MACRO.
  
  for my $val ( @val ) {
    next if grep($_ eq $val, @$x);   # Recursion lock
    $self->__use('UML::MetaModel::Foundation::Core::ModelElement')->__typecheck($val, "UML::MetaModel::Foundation::Core::Comment.annotatedElement");

    push(@{$x}, $val);               # Recursion lock

    # Remove and add associations with other ends.
        
  }
  
  $self;
}


=head2 remove_annotatedElement

  $obj->remove_annotatedElement($val);

Removes the Association to C<$val>.
Returns C<$obj>.

=cut
sub remove_annotatedElement ($@)
{
  my ($self, @val) = @_;
  
  my $x = $self->{'annotatedElement'} ||= [ ];
  
  for my $old ( @val ) {
    next unless grep($_ eq $old, @$x); # Recursion lock
    my $val = $old;
      
    $self->__use('UML::MetaModel::Foundation::Core::ModelElement')->__typecheck($val, "UML::MetaModel::Foundation::Core::Comment.annotatedElement");

    @$x = grep($_ ne $old, @$x);       # Recursion lock
    $val = undef;

    # Remove associations with other ends.

        ;

  }
  
  $self;
}


=head2 clear_annotatedElement

  $obj->clear_annotatedElement;

Clears the Association.
Returns C<$obj>.

=cut
sub clear_annotatedElement ($) 
{
  my ($self) = @_;
  
  my $x = $self->{'annotatedElement'} ||= [ ];
  my $val; # Place holder for other MACRO.
  
  $self->{'annotatedElement'} = [ ];  # Recursion lock
  for my $old ( @$x ) { # Recursion lock

    # Remove associations with other ends.

        ;

  }
  
  $self;
}




############################################################################

1; # is true!

############################################################################

### Keep these comments at end of file: ks.perl@kurtstephens.com 2003/04/06 ###
### Local Variables: ###
### mode:perl ###
### perl-indent-level:2 ###
### perl-continued-statement-offset:0 ###
### perl-brace-offset:0 ###
### perl-label-offset:0 ###
### End: ###

