Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jwall.object
Class Network  view Network download Network.java

java.lang.Object
  extended byorg.jwall.object.AbstractNetworkObject
      extended byorg.jwall.object.Network
All Implemented Interfaces:
java.lang.Comparable, org.jwall.gui.Enum, FirewallDataEventSource, NetworkObject, org.jwall.type.SortedDisplayable

public class Network
extends AbstractNetworkObject

A Host object represents a network that can be reached.


Field Summary
private  java.lang.String comment
           
private  javax.swing.Icon icon
           
private  org.jwall.type.IP ip
           
private  java.lang.String name
           
 
Fields inherited from class org.jwall.object.AbstractNetworkObject
 
Constructor Summary
Network(java.lang.String name, org.jwall.type.IP ip)
          Creates a new Network object.
Network(java.lang.String name, org.jwall.type.IP ip, java.lang.String comment)
          Creates a new Network object.
 
Method Summary
 void addIP(org.jwall.type.IP ip)
          Adds an IP to the internal list of IPs if it is not already present.
 int compareTo(java.lang.Object o)
          Compares this object with another, and returns a numerical result based on the comparison.
 boolean containsIP(org.jwall.type.IP ip)
          Checks whether the given IP is contained in this object.
private  void doAddIP(org.jwall.type.IP ip)
           
private  void doSetComment(java.lang.String comment)
           
private  void doSetName(java.lang.String name)
           
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
 java.lang.String getComment()
          Returns the comment associated with the NetworkObject.
 javax.swing.Icon getIcon()
          Returns the Icon associated with the object.
 org.jwall.type.IP[] getIPs()
          Returns all IP objects that are associated with this object.
 java.lang.String getName()
          Returns the name of the NetworkObject.
 boolean hasComment()
          Returns if the object has a comment.
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 java.lang.String resKey()
          A resource key for GUI display
 void setComment(java.lang.String comment)
          Sets the comment associated with the NetworkObject.
 void setIcon(javax.swing.Icon icon)
           
 void setIPs(org.jwall.type.IP[] ips)
          Sets the IP objects that are associated with this object.
 void setName(java.lang.String name)
          Sets the name of the NetworkObject.
 int size()
          Returns the number of objects contained in this network object.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class org.jwall.object.AbstractNetworkObject
addFirewallDataListener, removeFirewallDataListener, replaceWith, wasDeleted, wasModified
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

private java.lang.String name

ip

private org.jwall.type.IP ip

comment

private java.lang.String comment

icon

private javax.swing.Icon icon
Constructor Detail

Network

public Network(java.lang.String name,
               org.jwall.type.IP ip,
               java.lang.String comment)
Creates a new Network object.


Network

public Network(java.lang.String name,
               org.jwall.type.IP ip)
Creates a new Network object.

Method Detail

getName

public java.lang.String getName()
Returns the name of the NetworkObject.


setName

public void setName(java.lang.String name)
Sets the name of the NetworkObject. It is recommended that NetworkObjects have unique name although this is not enforced by this method.


getComment

public java.lang.String getComment()
Returns the comment associated with the NetworkObject.


setComment

public void setComment(java.lang.String comment)
Sets the comment associated with the NetworkObject.


hasComment

public boolean hasComment()
Returns if the object has a comment.


size

public int size()
Returns the number of objects contained in this network object. If the object is a group of objects the sum of all objects in the group is returned. Networks are counted as one object.


containsIP

public boolean containsIP(org.jwall.type.IP ip)
Checks whether the given IP is contained in this object. If this method is called for a host, true is only returned if the parameter equals to IP of the host (this implies that the given IP also is a host).


getIPs

public org.jwall.type.IP[] getIPs()
Returns all IP objects that are associated with this object.


setIPs

public void setIPs(org.jwall.type.IP[] ips)
Sets the IP objects that are associated with this object.


addIP

public void addIP(org.jwall.type.IP ip)
Adds an IP to the internal list of IPs if it is not already present. Calling this method on a host replaces the IP associated with this host.


getIcon

public javax.swing.Icon getIcon()
Returns the Icon associated with the object.


setIcon

public void setIcon(javax.swing.Icon icon)

compareTo

public int compareTo(java.lang.Object o)
Description copied from interface: java.lang.Comparable
Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).


doSetName

private void doSetName(java.lang.String name)

doSetComment

private void doSetComment(java.lang.String comment)

doAddIP

private void doAddIP(org.jwall.type.IP ip)

equals

public boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


resKey

public java.lang.String resKey()
A resource key for GUI display