DataEditorSupport.Env (Datasystems API)

java.lang.Object
- org.openide.loaders.OpenSupport.Env
- - org.openide.text.DataEditorSupport.Env

All Implemented Interfaces:

java.io.Serializable, org.openide.text.CloneableEditorSupport.Env, org.openide.windows.CloneableOpenSupport.Env

Enclosing class:

DataEditorSupport
```
public abstract static class DataEditorSupport.Env
extends OpenSupport.Env
implements org.openide.text.CloneableEditorSupport.Env
```
Environment that connects the data object and the CloneableEditorSupport.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.openide.text.CloneableEditorSupport.Env
  PROP_TIME
- Fields inherited from interface org.openide.windows.CloneableOpenSupport.Env
  PROP_MODIFIED, PROP_VALID

Constructor Summary

Constructors
Constructor Description

Env(DataObject obj)
Constructor.

Constructors
Constructor	Description
`Env(DataObject obj)`	Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`changeFile()`	Method that allows subclasses to notify this environment that the file associated with this support has changed and that the environment should listen on modifications of different file object.
`protected abstract org.openide.filesystems.FileObject`	`getFile()`	Getter for file associated with this environment.
`java.lang.String`	`getMimeType()`	Mime type of the document.
`java.util.Date`	`getTime()`	The time when the data has been modified
`java.io.InputStream`	`inputStream()`	Obtains the input stream.
`void`	`markModified()`	First of all tries to lock the primary file and if it succeeds it marks the data object modified.
`java.io.OutputStream`	`outputStream()`	Obtains the output stream.
`protected abstract org.openide.filesystems.FileLock`	`takeLock()`	Locks the file.
`void`	`unmarkModified()`	Reverse method that can be called to make the environment unmodified.

Methods inherited from interface org.openide.windows.CloneableOpenSupport.Env
addPropertyChangeListener, addVetoableChangeListener, findCloneableOpenSupport, isModified, isValid, removePropertyChangeListener, removeVetoableChangeListener

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

Methods inherited from class org.openide.loaders.OpenSupport.Env
addPropertyChangeListener, addVetoableChangeListener, findCloneableOpenSupport, firePropertyChange, fireVetoableChange, getDataObject, isModified, isValid, propertyChange, removePropertyChangeListener, removeVetoableChangeListener, toString, vetoableChange

- Constructor Detail
  - Env
```
public Env(DataObject obj)
```
    Constructor.
    
    Parameters:
    
    obj - this support should be associated with
- Method Detail
  - getFile
```
protected abstract org.openide.filesystems.FileObject getFile()
```
    Getter for file associated with this environment.
    
    Returns:
    
    the file input/output operation should be performed on
  - takeLock
```
protected abstract org.openide.filesystems.FileLock takeLock()
                                                      throws java.io.IOException
```
    Locks the file.
    
    Returns:
    
    the lock on the file getFile ()
    
    Throws:
    
    java.io.IOException - if the file cannot be locked
  - changeFile
```
protected final void changeFile()
```
    Method that allows subclasses to notify this environment that the file associated with this support has changed and that the environment should listen on modifications of different file object.
  - inputStream
```
public java.io.InputStream inputStream()
                                throws java.io.IOException
```
    Obtains the input stream.
    
    Specified by:
    
    inputStream in interface org.openide.text.CloneableEditorSupport.Env
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - outputStream
```
public java.io.OutputStream outputStream()
                                  throws java.io.IOException
```
    Obtains the output stream.
    
    Specified by:
    
    outputStream in interface org.openide.text.CloneableEditorSupport.Env
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - getTime
```
public java.util.Date getTime()
```
    The time when the data has been modified
    
    Specified by:
    
    getTime in interface org.openide.text.CloneableEditorSupport.Env
  - getMimeType
```
public java.lang.String getMimeType()
```
    Mime type of the document.
    
    Specified by:
    
    getMimeType in interface org.openide.text.CloneableEditorSupport.Env
    
    Returns:
    
    the mime type to use for the document
  - markModified
```
public void markModified()
                  throws java.io.IOException
```
    First of all tries to lock the primary file and if it succeeds it marks the data object modified.
    Note: There is a contract (better saying a curse) that this method has to call takeLock() method in order to keep working some special filesystem's feature. See issue #28212.
    
    Specified by:
    
    markModified in interface org.openide.windows.CloneableOpenSupport.Env
    
    Overrides:
    
    markModified in class OpenSupport.Env
    
    Throws:
    
    java.io.IOException - if the environment cannot be marked modified (for example when the file is readonly), when such exception is the support should discard all previous changes
    
    See Also:
    
    FileObject.isReadOnly()
  - unmarkModified
```
public void unmarkModified()
```
    Reverse method that can be called to make the environment unmodified.
    
    Specified by:
    
    unmarkModified in interface org.openide.windows.CloneableOpenSupport.Env
    
    Overrides:
    
    unmarkModified in class OpenSupport.Env

Class DataEditorSupport.Env

Field Summary

Fields inherited from interface org.openide.text.CloneableEditorSupport.Env

Fields inherited from interface org.openide.windows.CloneableOpenSupport.Env

Constructor Summary

Method Summary

Methods inherited from interface org.openide.windows.CloneableOpenSupport.Env

Methods inherited from class java.lang.Object

Methods inherited from class org.openide.loaders.OpenSupport.Env

Constructor Detail

Env

Method Detail

getFile

takeLock

changeFile

inputStream

outputStream

getTime

getMimeType

markModified

unmarkModified