/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.impl.protocol.mock;
import java.util.*;
import net.java.sip.communicator.service.protocol.*;
/**
* A simple, straightforward mock implementation of the Contact interface
* that can be manually created and used in testing a
* MetaContactList service
*
* @author Emil Ivov
*/
public class MockContact
extends AbstractContact
{
private String contactID = null;
private boolean isPersistent = true;
private boolean isResolved = true;
private MockContactGroup parentGroup = null;
private MockProvider parentProvider = null;
private PresenceStatus presenceStatus = MockStatusEnum.MOCK_STATUS_50;
/**
* Creates an instance of a meta contact with the specified string used
* as a name and identifier.
*
* @param id the identifier of this contact (also used as a name).
* @param parentProvider the provider that created us.
*/
public MockContact(String id,
MockProvider parentProvider)
{
this.contactID = id;
this.parentProvider = parentProvider;
}
/**
* Determines whether a specific <tt>Object</tt> is equal to this instance.
* <tt>MockContact</tt> defines equality on {@link Contact#getAddress()}
* regardless of their <tt>ProtocolProviderService</tt>.
*
* @param obj the <tt>Object</tt> which is to be compared to this instance
* @return <tt>true</tt> if the specified <tt>obj</tt> is equal to this
* instance; otherwise, <tt>false</tt>.
*/
@Override
public boolean equals(Object obj)
{
if (obj == null)
return false;
else if (obj == this)
return true;
else if (!obj.getClass().equals(getClass()))
return false;
else
{
Contact contact = (Contact) obj;
String address = contact.getAddress();
String thisAddress = getAddress();
return
(address == null)
? (thisAddress == null)
: address.equals(thisAddress);
}
}
/**
* Returns a String that can be used for identifying the contact.
*
* @return a String id representing and uniquely identifying the contact.
*/
public String getAddress()
{
return contactID;
}
/**
* Returns a String that could be used by any user interacting modules
* for referring to this contact.
*
* @return a String that can be used for referring to this contact when
* interacting with the user.
*/
public String getDisplayName()
{
return contactID;
}
/**
* Returns a byte array containing an image (most often a photo or an
* avatar) that the contact uses as a representation.
*
* @return byte[] an image representing the contact.
*/
public byte[] getImage()
{
return null;
}
/**
* Returns the group that contains this contact.
* @return a reference to the MockContactGroup that contains this contact.
*/
public ContactGroup getParentContactGroup()
{
return this.parentGroup;
}
/**
* Returns null as no persistent data is required and the contact address is
* sufficient for restoring the contact.
* <p>
* @return null as no such data is needed.
*/
public String getPersistentData()
{
return null;
}
/**
* Returns the status of the contact.
*
* @return always IcqStatusEnum.ONLINE.
*/
public PresenceStatus getPresenceStatus()
{
return this.presenceStatus;
}
/**
* Returns a reference to the protocol provider that created the contact.
*
* @return a refererence to an instance of the ProtocolProviderService
*/
public ProtocolProviderService getProtocolProvider()
{
return parentProvider;
}
/**
* Return the current status message of this contact.
*
* @return null as the protocol has currently no support of status messages
*/
public String getStatusMessage()
{
return null;
}
/**
* Returns a hash code value for this instance supported for the benefit of
* hashtables.
*
* @return a hash code value for this instance
*/
@Override
public int hashCode()
{
return getAddress().hashCode();
}
/**
* Determines whether or not this contact represents our own identity.
*
* @return true in case this is a contact that represents ourselves and
* false otherwise.
*/
public boolean isLocal()
{
return false;
}
/**
* Determines whether or not this contact is being stored by the server.
* Non persistent contacts are common in the case of simple, non-persistent
* presence operation sets. They could however also be seen in persistent
* presence operation sets when for example we have received an event
* from someone not on our contact list. Non persistent contacts are
* volatile even when coming from a persistent presence op. set. They would
* only exist until the application is closed and will not be there next
* time it is loaded.
* @return true if the contact is persistent and false otherwise.
*/
public boolean isPersistent()
{
return isPersistent;
}
/**
* Determines whether or not this contact has been resolved against the
* server. Unresolved contacts are used when initially loading a contact
* list that has been stored in a local file until the presence operation
* set has managed to retrieve all the contact list from the server and has
* properly mapped contacts to their on-line buddies.
* @return true if the contact has been resolved (mapped against a buddy)
* and false otherwise.
*/
public boolean isResolved()
{
return isResolved;
}
/**
* Modify the display name of this contact.
*
* @param displayName the new display name for this contact.
*/
public void setDisplayName(String displayName)
{
if (isResolved)
{
// TODO
// contactID = displayName;
}
}
/**
* This method is only called when the contact is added to a new
* <tt>MockContactGroup</tt> by the MockContactGroup itself.
* @param newParentGroup the <tt>MockContactGroup</tt> that is now parent
* of this <tt>MockContact</tt>
*/
void setParentGroup(MockContactGroup newParentGroup)
{
this.parentGroup = newParentGroup;
}
/**
* Sets <tt>mockPresenceStatus</tt> as the PresenceStatus that this contact
* is currently in.
* @param mockPresenceStatus the <tt>MockPresenceStatus</tt> currently valid
* for this contact.
*/
public void setPresenceStatus(MockStatusEnum mockPresenceStatus)
{
this.presenceStatus = mockPresenceStatus;
}
/**
* Makes the contact resolved or unresolved.
*
* @param resolved true to make the contact resolved; false to
* make it unresolved
*/
public void setResolved(boolean resolved)
{
this.isResolved = resolved;
}
/**
* Returns a string representation of this contact, containing most of its
* representative details.
*
* @return a string representation of this contact.
*/
@Override
public String toString()
{
StringBuffer buff = new StringBuffer("MockContact[ DisplayName=")
.append(getDisplayName()).append("]");
return buff.toString();
}
/**
* Indicates if this contact supports resources.
*
* @return <tt>false</tt> to indicate that this contact doesn't support
* resources
*/
@Override
public boolean supportResources()
{
return false;
}
/**
* Returns a collection of resources supported by this contact or null
* if it doesn't support resources.
*
* @return null, as this contact doesn't support resources
*/
@Override
public Collection<ContactResource> getResources()
{
return null;
}
public void setPersistent(boolean isPersistent)
{
this.isPersistent = isPersistent;
}
}