twitter4j

Class TwitterStreamFactory

java.lang.Object

twitter4j.TwitterStreamFactory

All Implemented Interfaces:

java.io.Serializable

public final class TwitterStreamFactory
extends java.lang.Object
implements java.io.Serializable

A factory class for TwitterFactory.
An instance of this class is completely thread safe and can be re-used and used concurrently.
Note that TwitterStream is NOT compatible with Google App Engine as GAE is not capable of handling requests longer than 30 seconds.

Since:

Twitter4J 2.1.0

Author:

Yusuke Yamamoto - yusuke at mac.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration	conf
private StatusListener	listener
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
TwitterStreamFactory() Creates a TwitterStreamFactory with the root configuration.
TwitterStreamFactory(Configuration conf) Creates a TwitterStreamFactory with the given configuration.
TwitterStreamFactory(Configuration conf, StatusListener listener) Creates a TwitterStreamFactory with the specified config and a listener.
TwitterStreamFactory(StatusListener listener) Creates a TwitterStreamFactory with the root configuration and a specified status listener.
TwitterStreamFactory(java.lang.String configTreePath) Creates a TwitterStreamFactory with a specified config tree.
TwitterStreamFactory(java.lang.String configTreePath, StatusListener listener) Creates a TwitterStreamFactory with a specified config tree and a listener.

Method Summary

Methods

Modifier and Type	Method and Description
TwitterStream	getInstance() Returns an instance.
TwitterStream	getInstance(Authorization auth) Returns a instance.
private TwitterStream	getInstance(Configuration conf)
private TwitterStream	getInstance(Configuration conf, Authorization auth)
TwitterStream	getInstance(java.lang.String screenName, java.lang.String password) Returns a Basic Authenticated instance.
TwitterStream	getOAuthAuthorizedInstance(AccessToken accessToken) Returns a OAuth Authenticated instance. consumer key and consumer Secret must be provided by twitter4j.properties, or system properties.
TwitterStream	getOAuthAuthorizedInstance(java.lang.String consumerKey, java.lang.String consumerSecret) Returns a OAuth Authenticated instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

listener

private final StatusListener listener

conf

private final Configuration conf

Constructor Detail

TwitterStreamFactory

public TwitterStreamFactory()

Creates a TwitterStreamFactory with the root configuration.

TwitterStreamFactory

public TwitterStreamFactory(Configuration conf)

Creates a TwitterStreamFactory with the given configuration.

Parameters:

conf - the configuration to use

Since:

Twitter4J 2.1.1

TwitterStreamFactory

public TwitterStreamFactory(StatusListener listener)

Creates a TwitterStreamFactory with the root configuration and a specified status listener.

Parameters:

listener - the listener

TwitterStreamFactory

public TwitterStreamFactory(java.lang.String configTreePath)

Creates a TwitterStreamFactory with a specified config tree.

Parameters:

configTreePath - the path

TwitterStreamFactory

public TwitterStreamFactory(java.lang.String configTreePath,
                    StatusListener listener)

Creates a TwitterStreamFactory with a specified config tree and a listener.

Parameters:

configTreePath - the path

listener - the listener

TwitterStreamFactory

public TwitterStreamFactory(Configuration conf,
                    StatusListener listener)

Creates a TwitterStreamFactory with the specified config and a listener.

Parameters:

conf - the configuration to use

listener - an optional status listener

Since:

Twitter4J 2.1.1

Method Detail

getInstance

public TwitterStream getInstance()

Returns an instance.

Returns:

default instance

getInstance

public TwitterStream getInstance(java.lang.String screenName,
                        java.lang.String password)

Returns a Basic Authenticated instance.

Parameters:

screenName - screen name

password - password

Returns:

an instance

getOAuthAuthorizedInstance

public TwitterStream getOAuthAuthorizedInstance(java.lang.String consumerKey,
                                       java.lang.String consumerSecret)

Returns a OAuth Authenticated instance.

Parameters:

consumerKey - consumer key

consumerSecret - consumer secret

Returns:

an instance

getOAuthAuthorizedInstance

public TwitterStream getOAuthAuthorizedInstance(AccessToken accessToken)

Returns a OAuth Authenticated instance.
consumer key and consumer Secret must be provided by twitter4j.properties, or system properties.

Parameters:

accessToken - access token

Returns:

an instance

getInstance

public TwitterStream getInstance(Authorization auth)

Returns a instance.

Returns:

default singleton instance

getInstance

private TwitterStream getInstance(Configuration conf,
                        Authorization auth)

getInstance

private TwitterStream getInstance(Configuration conf)