blob: 8557e17325b55f6b2fb5ce57f9ce9dabd90c2d09 (
plain) (
tree)
|
|
/*
* %CopyrightBegin%
*
* Copyright Ericsson AB 2000-2009. All Rights Reserved.
*
* The contents of this file are subject to the Erlang Public License,
* Version 1.1, (the "License"); you may not use this file except in
* compliance with the License. You should have received a copy of the
* Erlang Public License along with this software. If not, it can be
* retrieved online at http://www.erlang.org/.
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* %CopyrightEnd%
*/
package com.ericsson.otp.erlang;
/**
* Provides a Java representation of Erlang ports.
*/
public class OtpErlangPort extends OtpErlangObject {
// don't change this!
private static final long serialVersionUID = 4037115468007644704L;
private final String node;
private final int id;
private final int creation;
/*
* Create a unique Erlang port belonging to the local node. Since it isn't
* meaninful to do so, this constructor is private...
*
* @param self the local node.
*
* @deprecated use OtpLocalNode:createPort() instead
*/
@SuppressWarnings("unused")
private OtpErlangPort(final OtpSelf self) {
final OtpErlangPort p = self.createPort();
id = p.id;
creation = p.creation;
node = p.node;
}
/**
* Create an Erlang port from a stream containing a port encoded in Erlang
* external format.
*
* @param buf
* the stream containing the encoded port.
*
* @exception OtpErlangDecodeException
* if the buffer does not contain a valid external
* representation of an Erlang port.
*/
public OtpErlangPort(final OtpInputStream buf)
throws OtpErlangDecodeException {
final OtpErlangPort p = buf.read_port();
node = p.node();
id = p.id();
creation = p.creation();
}
/**
* Create an Erlang port from its components.
*
* @param node
* the nodename.
*
* @param id
* an arbitrary number. Only the low order 28 bits will be
* used.
*
* @param creation
* another arbitrary number. Only the low order 2 bits will
* be used.
*/
public OtpErlangPort(final String node, final int id, final int creation) {
this.node = node;
this.id = id & 0xfffffff; // 28 bits
this.creation = creation & 0x03; // 2 bits
}
/**
* Get the id number from the port.
*
* @return the id number from the port.
*/
public int id() {
return id;
}
/**
* Get the creation number from the port.
*
* @return the creation number from the port.
*/
public int creation() {
return creation;
}
/**
* Get the node name from the port.
*
* @return the node name from the port.
*/
public String node() {
return node;
}
/**
* Get the string representation of the port. Erlang ports are printed as
* #Port<node.id>.
*
* @return the string representation of the port.
*/
@Override
public String toString() {
return "#Port<" + node + "." + id + ">";
}
/**
* Convert this port to the equivalent Erlang external representation.
*
* @param buf
* an output stream to which the encoded port should be
* written.
*/
@Override
public void encode(final OtpOutputStream buf) {
buf.write_port(node, id, creation);
}
/**
* Determine if two ports are equal. Ports are equal if their components are
* equal.
*
* @param o
* the other port to compare to.
*
* @return true if the ports are equal, false otherwise.
*/
@Override
public boolean equals(final Object o) {
if (!(o instanceof OtpErlangPort)) {
return false;
}
final OtpErlangPort port = (OtpErlangPort) o;
return creation == port.creation && id == port.id
&& node.compareTo(port.node) == 0;
}
@Override
protected int doHashCode() {
OtpErlangObject.Hash hash = new OtpErlangObject.Hash(6);
hash.combine(creation);
hash.combine(id, node.hashCode());
return hash.valueOf();
}
}
|
