RedisZSetCommands.Weights (Spring Data Redis 2.7.1 API)

java.lang.Object
- org.springframework.data.redis.connection.RedisZSetCommands.Weights

Enclosing interface:

RedisZSetCommands
```
public static class RedisZSetCommands.Weights
extends Object
```
Value object encapsulating a multiplication factor for each input sorted set. This means that the score of every element in every input sorted set is multiplied by this factor before being passed to the aggregation function.

Since:

2.1

Author:

Mark Paluch, Christoph Strobl

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedisZSetCommands.Weights`	`apply(Function<Double,Double> operator)` Creates a new `RedisZSetCommands.Weights` object that contains all weights with `Function` applied.
`boolean`	`equals(Object o)`
`static RedisZSetCommands.Weights`	`fromSetCount(int count)` Creates equal `RedisZSetCommands.Weights` for a number of input sets `count` with a weight of one.
`double`	`getWeight(int index)` Retrieve the weight at `index`.
`int`	`hashCode()`
`RedisZSetCommands.Weights`	`multiply(double multiplier)` Creates a new `RedisZSetCommands.Weights` object that contains all weights multiplied by `multiplier`
`RedisZSetCommands.Weights`	`multiply(int multiplier)` Creates a new `RedisZSetCommands.Weights` object that contains all weights multiplied by `multiplier`
`static RedisZSetCommands.Weights`	`of(double... weights)` Create new `RedisZSetCommands.Weights` given `weights` as `double`.
`static RedisZSetCommands.Weights`	`of(int... weights)` Create new `RedisZSetCommands.Weights` given `weights` as `int`.
`int`	`size()`
`double[]`	`toArray()`
`List<Double>`	`toList()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
public static RedisZSetCommands.Weights of(int... weights)
```
    Create new RedisZSetCommands.Weights given weights as int.
    
    Parameters:
    
    weights - must not be null.
    
    Returns:
    
    the RedisZSetCommands.Weights for weights.
  - of
```
public static RedisZSetCommands.Weights of(double... weights)
```
    Create new RedisZSetCommands.Weights given weights as double.
    
    Parameters:
    
    weights - must not be null.
    
    Returns:
    
    the RedisZSetCommands.Weights for weights.
  - fromSetCount
```
public static RedisZSetCommands.Weights fromSetCount(int count)
```
    Creates equal RedisZSetCommands.Weights for a number of input sets count with a weight of one.
    
    Parameters:
    
    count - number of input sets. Must be greater or equal to zero.
    
    Returns:
    
    equal RedisZSetCommands.Weights for a number of input sets with a weight of one.
  - multiply
```
public RedisZSetCommands.Weights multiply(int multiplier)
```
    Creates a new RedisZSetCommands.Weights object that contains all weights multiplied by multiplier
    
    Parameters:
    
    multiplier - multiplier used to multiply each weight with.
    
    Returns:
    
    equal RedisZSetCommands.Weights for a number of input sets with a weight of one.
  - multiply
```
public RedisZSetCommands.Weights multiply(double multiplier)
```
    Creates a new RedisZSetCommands.Weights object that contains all weights multiplied by multiplier
    
    Parameters:
    
    multiplier - multiplier used to multiply each weight with.
    
    Returns:
    
    equal RedisZSetCommands.Weights for a number of input sets with a weight of one.
  - apply
```
public RedisZSetCommands.Weights apply(Function<Double,Double> operator)
```
    Creates a new RedisZSetCommands.Weights object that contains all weights with Function applied.
    
    Parameters:
    
    operator - operator function.
    
    Returns:
    
    the new RedisZSetCommands.Weights with DoubleUnaryOperator applied.
  - getWeight
```
public double getWeight(int index)
```
    Retrieve the weight at index.
    
    Parameters:
    
    index - the weight index.
    
    Returns:
    
    the weight at index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range
  - size
```
public int size()
```
    Returns:
    
    number of weights.
  - toArray
```
public double[] toArray()
```
    Returns:
    
    an array containing all of the weights in this list in proper sequence (from first to last element).
  - toList
```
public List<Double> toList()
```
    Returns:
    
    a List containing all of the weights in this list in proper sequence (from first to last element).
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class RedisZSetCommands.Weights

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

fromSetCount

multiply

multiply

apply

getWeight

size

toArray

toList

equals

hashCode