UserProperty

java.lang.Object
- util.PropertyContainer
- - stella.util.UserProperty

All Implemented Interfaces:

Cloneable, UserProfile, Initializable, PropertySupplying
```
public class UserProperty
extends PropertyContainer
implements UserProfile, Initializable
```
A class to facilitate user properties on a telescope. It is a convenience class to allow simple properties retrieval.

Nested Class Summary
- Nested classes/interfaces inherited from interface stella.util.UserProfile
  UserProfile.Affil, UserProfile.Notifies

Field Summary

Fields
Modifier and Type	Field and Description
`private Collection<javax.mail.internet.InternetAddress>`	`address` The list of e-mail addresses.
`private List<UserProfile.Affil>`	`affils` The list of allowed affiliations.
`private static Color`	`DEFCOLOR` The default color.
`private static String`	`DEFINSTITUTION` The default user institution.
`private static String`	`DEFNOTIFY` The default user-notification.
`static String`	`KEY_COLOR` The preferred color for various display purposes.
`static String`	`KEY_EMAIL` The e-mail addresses of the user, as a comma-separated list.
`static String`	`KEY_INSTITUTION` The institution observing time is accounted to.
`static String`	`KEY_NOTIFY` The notification preferences for the user, as a comma-list.
`static String`	`KEY_USER` The user this properties are bound to.
`private UserProfile.Affil`	`mainaffil` The default affiliation (first in list or explicedly set).
`private Collection<UserProfile.Notifies>`	`notify` The list of notification events.

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.util.UserProfile
AFFILCOLOR, SYSTEM

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

UserProperty(Map<String,String> prop)
Creates a new user-preferences helper.

Constructors
Constructor and Description
`UserProperty(Map<String,String> prop)` Creates a new user-preferences helper.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<UserProfile.Affil>`	`getAllowedInstitutions()` Returns all allowed billing institutions for this user.
`Color`	`getColor()` Retunrs the user color.
`Collection<? extends javax.mail.Address>`	`getEmail()` Returns the e-mail list.
`UserProfile.Affil`	`getInstitution()` Returns the institution.
`PublicKey`	`getKey()` Return null.
`Collection<UserProfile.Notifies>`	`getNotify()` Returns the notification list.
`PasswordAuthentication`	`getPassword()` Return null.
`String`	`getUser()` Returns the user name.
`void`	`init()` Checks if the user name and the e-mail address is set.
`boolean`	`setInstitution(UserProfile.Affil allowed)` Tries to set a new affiliation, which is only allowed if the new affiliation is part of the `KEY_INSTITUTION` list.
`String`	`toString()` Returns a string description.

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_USER
```
public static final String KEY_USER
```
    The user this properties are bound to.
    
    See Also:
    
    Constant Field Values
  - KEY_INSTITUTION
```
public static final String KEY_INSTITUTION
```
    The institution observing time is accounted to.
    
    See Also:
    
    Constant Field Values
  - KEY_EMAIL
```
public static final String KEY_EMAIL
```
    The e-mail addresses of the user, as a comma-separated list.
    
    See Also:
    
    Constant Field Values
  - KEY_NOTIFY
```
public static final String KEY_NOTIFY
```
    The notification preferences for the user, as a comma-list.
    
    See Also:
    
    Constant Field Values
  - KEY_COLOR
```
public static final String KEY_COLOR
```
    The preferred color for various display purposes.
    
    See Also:
    
    Constant Field Values
  - DEFINSTITUTION
```
private static final String DEFINSTITUTION
```
    The default user institution.
  - DEFNOTIFY
```
private static final String DEFNOTIFY
```
    The default user-notification.
  - DEFCOLOR
```
private static final Color DEFCOLOR
```
    The default color.
  - address
```
private Collection<javax.mail.internet.InternetAddress> address
```
    The list of e-mail addresses.
  - notify
```
private Collection<UserProfile.Notifies> notify
```
    The list of notification events.
  - affils
```
private List<UserProfile.Affil> affils
```
    The list of allowed affiliations.
  - mainaffil
```
private UserProfile.Affil mainaffil
```
    The default affiliation (first in list or explicedly set).
- Constructor Detail
  - UserProperty
```
public UserProperty(Map<String,String> prop)
```
    Creates a new user-preferences helper.
- Method Detail
  - init
```
public void init()
```
    Checks if the user name and the e-mail address is set. Constructs the notification list of strings.
    
    Specified by:
    
    init in interface Initializable
  - getUser
```
public String getUser()
```
    Returns the user name. Always defined if object survived init.
    
    Specified by:
    
    getUser in interface UserProfile
  - getInstitution
```
public UserProfile.Affil getInstitution()
```
    Returns the institution.
    
    Specified by:
    
    getInstitution in interface UserProfile
  - getAllowedInstitutions
```
public List<UserProfile.Affil> getAllowedInstitutions()
```
    Description copied from interface: UserProfile
    
    Returns all allowed billing institutions for this user.
    
    Specified by:
    
    getAllowedInstitutions in interface UserProfile
  - setInstitution
```
public boolean setInstitution(UserProfile.Affil allowed)
```
    Tries to set a new affiliation, which is only allowed if the new affiliation is part of the KEY_INSTITUTION list.
    
    Specified by:
    
    setInstitution in interface UserProfile
  - getEmail
```
public Collection<? extends javax.mail.Address> getEmail()
```
    Returns the e-mail list.
    
    Specified by:
    
    getEmail in interface UserProfile
  - getNotify
```
public Collection<UserProfile.Notifies> getNotify()
```
    Returns the notification list.
    
    Specified by:
    
    getNotify in interface UserProfile
  - getColor
```
public Color getColor()
```
    Retunrs the user color.
    
    Specified by:
    
    getColor in interface UserProfile
  - toString
```
public String toString()
```
    Returns a string description.
    
    Overrides:
    
    toString in class PropertyContainer
  - getKey
```
public PublicKey getKey()
```
    Return null.
    
    Specified by:
    
    getKey in interface UserProfile
  - getPassword
```
public PasswordAuthentication getPassword()
```
    Return null.
    
    Specified by:
    
    getPassword in interface UserProfile

Class UserProperty

Nested Class Summary

Nested classes/interfaces inherited from interface stella.util.UserProfile

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface stella.util.UserProfile

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_USER

KEY_INSTITUTION

KEY_EMAIL

KEY_NOTIFY

KEY_COLOR

DEFINSTITUTION

DEFNOTIFY

DEFCOLOR

address

notify

affils

mainaffil

Constructor Detail

UserProperty

Method Detail

init

getUser

getInstitution

getAllowedInstitutions

setInstitution

getEmail

getNotify

getColor

toString

getKey

getPassword