org.netbeans.modules.projectapi.ProjectFileEncodingQueryImplementation

#position=200

org.netbeans.modules.projectapi.DataObjectEncodingQueryImplementation

#position=100

     * <li>{@link org.netbeans.spi.queries.FileEncodingQueryImplementation}</li>

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.projectapi;

import java.nio.charset.Charset;

import org.netbeans.spi.queries.FileEncodingQueryImplementation;

import org.openide.filesystems.FileObject;

import org.openide.loaders.DataObject;

import org.openide.loaders.DataObjectNotFoundException;

import org.openide.util.Exceptions;

/**

 *

 * @author Tomas Zezula

 */

public class DataObjectEncodingQueryImplementation implements FileEncodingQueryImplementation {

    /** Creates a new instance of DataObjectEncodingQueryImplementation */

    public DataObjectEncodingQueryImplementation() {

    }

    public Charset getEncoding(FileObject file) {

        assert file != null;

        try {

            DataObject dobj = DataObject.find(file);

            FileEncodingQueryImplementation impl = dobj.getLookup().lookup (FileEncodingQueryImplementation.class);

            if (impl == null)  {

                return null;

            }

            return impl.getEncoding(file);

        } catch (DataObjectNotFoundException donf) {

            Exceptions.printStackTrace(donf);

            return null;

        }

    }

}

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.projectapi;

import java.nio.charset.Charset;

import org.netbeans.api.project.FileOwnerQuery;

import org.netbeans.api.project.Project;

import org.netbeans.spi.queries.FileEncodingQueryImplementation;

import org.openide.filesystems.FileObject;

/**

 *

 * @author Tomas Zezula

 */

public class ProjectFileEncodingQueryImplementation implements FileEncodingQueryImplementation {

    public ProjectFileEncodingQueryImplementation() {

    }

    public Charset getEncoding(FileObject file) {

        Project p = FileOwnerQuery.getOwner(file);

        if (p == null) {

            return null;

        }

        FileEncodingQueryImplementation delegate = p.getLookup().lookup(FileEncodingQueryImplementation.class);

        if (delegate == null) {

            return null;

        }

        return delegate.getEncoding(file);

    }

}

<!--

        <question id="arch-where" when="impl">

            Where one can find sources for your module?

            <hint>

                Please provide link to the CVS web client at

                http://www.netbeans.org/download/source_browse.html

                or just use tag defaultanswer generate='here'

            </hint>

        </question>

-->

 <answer id="arch-where">

  <defaultanswer generate='here' />

 </answer>

<!--

        <question id="compat-deprecation" when="init">

            How the introduction of your project influences functionality

            provided by previous version of the product?

            <hint>

            If you are planning to deprecate/remove/change any existing APIs,

            list them here accompanied with the reason explaining why you

            are doing so.

            </hint>

        </question>

-->

 <answer id="compat-deprecation">

  <p>

   Addition of a new API.

  </p>

 </answer>

<!--

        <question id="exec-ant-tasks" when="impl">

            Do you define or register any ant tasks that other can use?

            <hint>

            If you provide an ant task that users can use, you need to be very

            careful about its syntax and behaviour, as it most likely forms an

	          API for end users and as there is a lot of end users, their reaction

            when such API gets broken can be pretty strong.

            </hint>

        </question>

-->

 <answer id="exec-ant-tasks">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="resources-preferences" when="final">

            Does your module uses preferences via Preferences API? Does your module use NbPreferences or

            or regular JDK Preferences ? Does it read, write or both ? 

            Does it share preferences with other modules ? If so, then why ?

            <hint>

                You may use

                    <api type="export" group="preferences"

                    name="preference node name" category="private">

                    description of individual keys, where it is used, what it

                    influences, whether the module reads/write it, etc.

                    </api>

                Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.

                Note that if you use NbPreferences this name will then be the same as the code name base of the module.

            </hint>

        </question>

-->

<answer id="resources-preferences">    

  <p>

      The module internally uses <code>NbPreferences</code> to store the default value of encoding of a new project.

      Clients should not access this preferences directly using preferences API but they should use

      the <code>FileEncodingQuery</code> methods.

  </p>

  <api group="preferences" name="org.netbeans.api.queries" type="export" category="private" url="">

      <table>

          <tbody>

              <tr>

                  <th>key</th>

                  <th>description</th>

                  <th>read</th>

                  <th>write</th>

              </tr>

              <tr>

                  <td>default-encoding</td>

                  <td>Default encoding which should be used for new project</td>

                  <td>x</td>

                  <td>x</td>

              </tr>

          </tbody>

      </table>

  </api>

 </answer>

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.api.queries;

import java.nio.charset.Charset;

import java.util.prefs.Preferences;

import org.netbeans.spi.queries.FileEncodingQueryImplementation;

import org.openide.filesystems.FileObject;

import org.openide.util.Lookup;

import org.openide.util.NbPreferences;

/**

 * The query is used for finding encoding of files.

 * The query should be used when reading or writing files to use the

 * correct encoding.

 * @since org.netbeans.modules.queries/1 1.9

 * @see FileEncodingQueryImplementation

 * @author Tomas Zezula

 */

public class FileEncodingQuery {

    private static final String DEFAULT_ENCODING = "default-encoding";    //NOI18N

    private static final String UTF_8 = "UTF-8";                          //NOI18N    

    private FileEncodingQuery() {

    }

    /**

     * Returns encoding of given file.

     * @param file to find an encoding for

     * @return encoding which should be used for given file, never returns null.

     */

    public static Charset getEncoding (FileObject file) {

        assert file != null;

        Charset encoding;

        for (FileEncodingQueryImplementation impl : Lookup.getDefault().lookupAll(FileEncodingQueryImplementation.class)) {

            encoding = impl.getEncoding(file);

            if (encoding != null) {

                return encoding;

            }

        }

        return Charset.defaultCharset();

    }   

    /**

     * Returns the encoding which should be used for newly created projects.

     * The typical user of this method is a code generating new projects.

     * The returned value is a last used encoding set for project.

     * @return the default encoding 

     * 

     */

    public static Charset getDefaultEncoding () {

        Preferences prefs = NbPreferences.forModule(FileEncodingQuery.class);

        String defaultEncoding = prefs.get (DEFAULT_ENCODING,UTF_8);

        return Charset.forName(defaultEncoding);

    }

    /**

     * Sets the encoding which should be used for newly created projects.

     * The typical user of this method is a project customizer, when the

     * user sets a new encoding the customizer code should update the defaul

     * encoding by this method.

     * @param encoding the new default encoding

     * 

     */

    public static void setDefaultEncoding (final Charset encoding) {

        assert encoding != null;

        Preferences prefs = NbPreferences.forModule(FileEncodingQuery.class);

        prefs.put(DEFAULT_ENCODING, encoding.name());

    }

}

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (the License). You may not use this file except in

 * compliance with the License.

 *

 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.spi.queries;

import java.nio.charset.Charset;

import org.openide.filesystems.FileObject;

/**

 * Information about encoding of a file.

 * <p>

 * A default implementations are registered by the

 * <code>org.netbeans.modules.projectapi</code> module which firstly looks up the

 * implementation of this interface in the <code>DataObject</code> lookup. When

 * available it delegates to it. When the implementation isn't available in the

 * <code>DataObject</code> lookup or it returns null it tries to find a

 * project corresponding to the file and checks whether that project has an

 * implementation of this interface in its lookup. If so, it delegates to 

 * that implementation. Therefore it is not generally necessary

 * for a project type provider nor data loader to register its own global implementation of

 * this query. 

 * </p> 

 * @see org.netbeans.api.queries.FileEncodingQuery

 * @since org.netbeans.modules.queries/1 1.9

 * @author Tomas Zezula

 */

public interface FileEncodingQueryImplementation {

    /**

     * Returns encoding of a given file.

     * @param file to find an encoding for

     * @return encoding which should be used for given file

     * or null when nothing is known about the file encoding.

     */

    public Charset getEncoding (FileObject file);

}