package DNS::Oterica::Node;
# ABSTRACT: DNSO node. belongs to families.
$DNS::Oterica::Node::VERSION = '0.203';
use Moose;
use DNS::Oterica::Role::RecordMaker;
#pod =head1 OVERVIEW
#pod
#pod A node is any part of a network, either a domain or a node. It is a member of
#pod zero or more families.
#pod
#pod Like other DNS::Oterica objects, they should be created through the hub.
#pod
#pod =attr domain
#pod
#pod This is a string representing the domain's domain name, for example
#pod F<example.com>.
#pod
#pod =cut
has domain => (is => 'ro', isa => 'Str', required => 1);
#pod =attr families
#pod
#pod This is an arrayref of the families in which the node has been placed.
#pod
#pod =cut
has families => (is => 'ro', isa => 'ArrayRef', default => sub { [] });
#pod =method add_to_family
#pod
#pod $node->add_to_family($family);
#pod
#pod This method adds the node to the given family, which may be given either as an
#pod object or as a name.
#pod
#pod If the node is already in the family, nothing happens.
#pod
#pod =cut
sub add_to_family {
my ($self, $family) = @_;
$family = $self->hub->node_family($family) unless ref $family;
return if $self->in_node_family($family);
$family->add_node($self);
push @{ $self->families }, $family;
}
#pod =method in_node_family
#pod
#pod if ($node->in_node_family($family)) { ... }
#pod
#pod This method returns true if the node is a member of the named (or passed)
#pod family and false otherwise.
#pod
#pod =cut
sub in_node_family {
my ($self, $family) = @_;
$family = $self->hub->node_family($family) unless ref $family;
for my $node_family (@{ $self->families }) {
return 1 if $family == $node_family;
}
return;
}
#pod =method as_data_lines
#pod
#pod This method returns a list of lines of configuration output.
#pod
#pod By default, it returns nothing.
#pod
#pod =cut
sub as_data_lines {
confess 'do not call ->as_data_lines in non-list context' unless wantarray;
return;
}
with 'DNS::Oterica::Role::HasHub';
__PACKAGE__->meta->make_immutable;
no Moose;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
DNS::Oterica::Node - DNSO node. belongs to families.
=head1 VERSION
version 0.203
=head1 OVERVIEW
A node is any part of a network, either a domain or a node. It is a member of
zero or more families.
Like other DNS::Oterica objects, they should be created through the hub.
=head1 ATTRIBUTES
=head2 domain
This is a string representing the domain's domain name, for example
F<example.com>.
=head2 families
This is an arrayref of the families in which the node has been placed.
=head1 METHODS
=head2 add_to_family
$node->add_to_family($family);
This method adds the node to the given family, which may be given either as an
object or as a name.
If the node is already in the family, nothing happens.
=head2 in_node_family
if ($node->in_node_family($family)) { ... }
This method returns true if the node is a member of the named (or passed)
family and false otherwise.
=head2 as_data_lines
This method returns a list of lines of configuration output.
By default, it returns nothing.
=head1 AUTHOR
Ricardo SIGNES <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut